Brinca Website

Brazil Canada Community Association Website

Setup local development

Follow these steps to set up the project:

Requirements

• Node.js 20+
• PNPM 10+

1. Clone the repository:

   git clone https://github.com/marceloglacial/brinca-website.git
   cd brinca-website

2. Install dependencies:

   pnpm install

3. Set up environment variables:

   Use dotenv.org to manage your environment variables.

   Open the environment variables configuration:

   pnpm env:open

   Pull the latest environment variables:

   # Local development using brinca-api running
   pnpm env:pull
   
   # Use staging database
   pnpm env:pull-staging
   
   # Use prod database
   pnpm env:pull-prod
   

4. Build the project:

   pnpm build

5. Run the development server:

   pnpm dev

Useful Scripts

• pnpm lint: Lint the codebase.
• pnpm format: Format the codebase.
• pnpm env:open: Open the environment variables configuration.
• pnpm env:pull: Pull the latest environment variables.
• pnpm env:push: Push your local environment variables.

Stack

• ESLint
• Husky
• Next.js
• Prettier
• React Server Components
• Tailwind CSS

License

This project is licensed under the MIT License - see the LICENSE file for details.