Outcome Tracker

Source code for the frontend of the Build Canada Outcome Tracker. The API repo is OutcomeTrackerAPI.

Getting Started

• Fork the repo, clone it, and install dependencies:

  git clone https://github.com/BuildCanada/OutcomeTracker.git
  cd OutcomeTracker
  pnpm install

• Copy .env.example to .env

  • If you're using the production API, set NEXT_PUBLIC_API_URL=https://www.buildcanada.com/tracker/api/v1
  • If you're running the API locally, set NEXT_PUBLIC_API_URL=http://localhost:3000/

• Run the Frontend

  pnpm turbo

• 🎉 Time to explore! Head over to http://localhost:4444/tracker to see your local instance in action!

Linting

This project uses ESLint with Next.js configuration. Run linting with:

pnpm lint          # Check for linting issues
pnpm lint:fix      # Auto-fix auto-fixable issues

The linting configuration enforces TypeScript best practices, React rules, and Next.js optimizations while keeping most issues as warnings (temporarily) to avoid blocking development.

Git Hooks

This project automatically runs linting checks before each commit using simple-git-hooks. This is enabled automatically when you run pnpm install. If you need to enable it manually:

npx simple-git-hooks

If linting fails, the commit will be blocked until issues are resolved.

Metrics

Metrics are scraped using github actions which automatically updates the repo with up to date data.

Contributing

We would love to have your help! Please fill in our volunteer intake form.