Development Setup

Development Environment Setup

This guide will help you set up your development environment for working on the Squared project.

Prerequisites

• Node.js (v14 or later)
• pnpm (v6 or later)
• Git

Setup Steps

1. Clone the repository:

   git clone https://github.com/squared/squared.git
   cd squared
   

2. Install dependencies:

   pnpm install
   

3. Set up environment variables:

   • Copy .env.example to .env in each project directory (www, web, api)
   • Fill in the required values in each .env file

4. Start the development servers:

   pnpm dev
   

   This will start all three applications (www, web, api) in development mode.

IDE Configuration

We recommend using Visual Studio Code with the following extensions:

• Biome
• Tailwind CSS IntelliSense

Troubleshooting

If you encounter any issues during setup, please refer to the Common Issues page or reach out to the development team.