Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 1.93 KB

README.md

File metadata and controls

77 lines (47 loc) · 1.93 KB

1. SETUP

1.1. Create environment file

  1. Create .env file in backend/src/config
  2. Copy contents from src/config/.env.example into .env

1.2. AWS S3 bucket

Refer Getting started with Amazon S3 to create S3 bucket

After configuring, update credentials for AWS S3 in .env

1.3. AWS RDS

Refer Create a MySQL DB instance to create MySQL RDS

After configuring, update credentials for AWS RDS in .env

1.4. Email User

In order to send welcome emails, you will require a gmail account and app password. Follow this step-by-step guide

After configuring, update credentials for Automated Emails in .env

1.5. Miscellaneous

  • Update PORT with the desired port to run the express server on
  • Update JWT_TOKEN_SECRET with a string to be able to sign JSON web tokens

2. DB MIGRATIONS

Follow given steps to run drizzle migrations to RDS

# Generate database schema
$ npm run db:generate

# Run migrations
$ npm run db:migrate

3. START SERVER

Follow the given commands to start the server.

# Install dependencies
$ cd pixelle/backend
$ npm i

# Run server
$ npm run dev

The server should now be running on http://localhost:[PORT] (default: 3000)

4. NEED HELP?

If you encounter any issues, feel free to open a GitHub issue or reach out to the maintainers

Made with ♥️ by Nav.