Skip to content

README.md

Latest commit

 

History

History
59 lines (37 loc) · 1.49 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.49 KB

Interprovincial Trade Barriers Tracker

Getting Started

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

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

  • Run the app

    pnpm turbo

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

Sample .env

This project uses Supabase for storage. To set up your own developer environment, add these variables to a .env file at the root of the project:

DATABASE_TABLE_NAME = 
DATABASE_TABLE_NAME_THEMES = 

SUPABASE_URL = 
SUPABASE_ANON_KEY = 
SUPABASE_SERVICE_ROLE_KEY =

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.

Contributing

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