Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.02 KB
Raw

Contributing

Thanks for your interest in contributing to next-international!

Requirements

  • node >= 20
  • pnpm >= 8

Getting Started

  1. Fork the repository, then clone it locally
  2. Run pnpm install at the root of the repository
  3. Setup the environment variables:
    1. Copy .env.example to .env: 
      cp apps/dashboard/.env.example apps/dashboard/.env
    2. Open the .env file and fill in the GitHub and/or Google OAuth credentials by following the instructions
  4. Setup the local SQLite database:
    1. Install the turso CLI: 
      curl -sSfL https://get.tur.so/install.sh | bash
    2. Install the sqld CLI from the releases or with Homebrew: 
      brew tap libsql/sqld
brew install sqld
  5. Navigate to the root of the repository and run pnpm dev

Before submitting a PR, run the test, lint, and typecheck scripts from the root of the repository.