Description

This README file provides a description of the backend project located in the Node-Workspace directory.

Project setup

$ npm install

Compile and run the project

$ npm run start:dev

Environment Variables

The following environment variables are used in the .env file:

Server

• PORT: The port on which the server runs. Example: 3001
• BASE_URL: The base URL of the server. Example: "http://localhost:3001"
• SECRET_KEY: The secret key used for various cryptographic operations. Example: "23423424245DFSJHR24524@3@@3!2*%**96*"

Database

• USER: The database user. Example: postgres
• DATABASE: The name of the database. Example: dash_sphere
• HOST: The database host. Example: localhost
• PORT: The database port. Example: 5432
• DATABASE_URL: The full database connection URL. Example: "postgresql://postgres:admin@localhost:5432/dash_sphere?schema=public"

Twilio

• TWILIO_ACCOUNT_SID: The Twilio account SID. Example: AC736a59a1baea8cd0ca23f0ab9a857121
• TWILIO_AUTH_TOKEN: The Twilio authentication token. Example: d6319c9cdfc6e26a15a636411ae9c037
• TWILIO_VERIFICATION_SERVICE_SID: The Twilio verification service SID. Example: VAd9f4e18304c15405e759fd4115b3966d
• TWILIO_SENDER_PHONE_NUMBER: The Twilio sender phone number. Example: "+925405464752"

Author

• Zeeshan Ali