This section will give you the instruction about setting up this project locally.
These are the lists of tools that you need to run the project.
- Clone the repo
[email protected]:Tsaikkari/Senior-Backend.git
- Install dependencies:
npm install
- For Mac and Linux user, give the permission to execute
script.sh
file. The script will run a postgres container as the app's database
chmod -x ./script.sh;
- Create a
.env
file in the root directory and include the following varables:
PORT = 5000
DB_PASSWORD = seniorHappy
JWT_SECRET = ashdjgksdkfj
- Finally, start the app:
npm start
- NODE_ENV
- PORT
- JWT_SECRET
- LOCALE
PostgreSQL
- DB_PASSWORD
- DATABASE_URL
Sendinblue
- SIB_API_KEY
- EMAIL_LOGIN
- EMAIL_PASSWORD
Stripe
- STRIPE_API_KEY
- STRIPE_WEBHOOK_SECRET
Posti
- POSTI_USERNAME
- POSTI_PASSWORD
- POSTI_CUSTOMER_NUMBER
The message of the commit should only follow the following format: ["CI", "CHORE", "DOCS", "FEATURE", "FIX", "PERF", "REFACTOR", "REVERT", "STYLE", "HOTPATCH"] EG:- FEATURE: Description about Feature