A simple Reddit clone

Running in dev environment

1. Install necessary tools:

• Docker - container management
• Docker Compose - containers defenition
• Pkl - configuration
• LocalStack - local AWS services
• pnpm - package management

2. Install/Build dependencies

• Run pnpm i in the root directory of the project
• Change the directory to <project_root>/packages/common, then run: pnpm build

3. Evaluate the default development configuration for API:

• Run pnpm pkl:eval in the root directory of the project

4. Start the necessary services

• Run make start_services in the root directory of the project
• If there are not enough permissions, run sudo make start_services (for linux & macos)

5. Start the API

• Change the directory to <project_root>/apps/api
• Run pnpm start:dev to start the backend server
• If there are not enough permissions, run sudo pnpm start:dev (for linux & macos)
• It will run on port 8080 unless the PORT environment variable is set

6. Start the web app

• Change the directory to <project_root>/apps/web
• Run pnpm start to start the web app development server
• It will run on port 4200

Running in Docker on a local machine

1. Build the images

• Run sudo make build_images

2. Start the local services

• Run sudo make start_services

3. Run the images

• Run sudo make run_images

4. Access the application

• API is exposed on port 8080
• Web application is exposed on port 4200