positonic / oso

Measuring the impact of open source software

oso

Open Source Observer is a free analytics suite that helps funders measure the impact of open source software contributions to the health of their ecosystem.

opensource.observer

Organization

• /docs: documentation (Docusaurus)
  • on Vercel - Production build
• /frontend: frontend application (Next.js)
  • on Vercel - Production build
• /indexer: Data indexer
  • on GitHub actions

Quickstart

Setup and build the frontend

First, make sure the environment variables are set for ./frontend. Take a look at ./frontend/.env.local.example for the complete list.

• You can either set these yourself (e.g. in CI/CD)
• or copy the file to .env.local and populate it.

Then do a turbo build of all apps, run the following:

pnpm install
pnpm build

The resulting static site can be found in ./build/.

Running the prod server

If you've already run the build, you can use pnpm serve to serve the built files

Running the frontend dev server

To run a dev server that watches for changes across code and Plasmic, run:

pnpm dev:frontend

Playbooks

For setup and common operations for each subproject, navigate into the respective directory and check out the README.md.