Getting Started

1. Install Dependencies

First, install the project dependencies using pnpm:

pnpm install

This will download all required packages listed in package.json.

2. Start MongoDB and Valkey (Redis equivalent) Locally with Docker

Next, you need to run MongoDB and Valkey (a Redis-like service) locally using Docker.

Make sure you have Docker and Docker Compose installed.

Start the services with:

docker-compose up

This will:

• Launch a MongoDB container with pre-seeded data for development.
• Launch a Valkey container (used as a Redis alternative).

3. Connect to AWS

The app uses the AWS SDK for certain features, so make sure you're connected to AWS locally to avoid errors.

Steps:

1. Install AWS CLI (if not already installed):

Aws Documentation

2. Configure AWS CLI:

   Run the following command and enter your AWS credentials:

   aws configure

   This will ask for your Access Key ID, Secret Access Key, Region, and Output Format.

4. Set Up Environment Variables

Copy the .env.development file to .env to configure your local environment:

cp .env.development .env

5. Start the Server

Finally, start the development server:

pnpm run dev

This will launch the server and you should be able to access the app locally.

---

Notes:

• If you encounter errors, check the console logs. If there are any AWS-related errors, it usually means you're not properly authenticated with AWS.
• Ensure that Docker is running when using docker-compose up.

That's it! Your local development environment should now be set up.