README.md

Itfest Backend

Steps to run this project:

1. Run npm install command
2. Setup database settings inside ormconfig.json file
3. Run npm start command

Some admin setting will be provided at npm run manage

Environment

To run this project please specify the following environment variable

# Only Postgres are supported
DB_NAME #Name of database
DB_URL #URL of database including auth

SECRET #JWT secret
QRKEY #32 character string for qr data encryption

HOST_URL # URL of hosted server
PORT #Service port

# SMTP options, based on https://nodemailer.com/smtp/
SMTP_HOST
SMTP_PORT
SMTP_SECURE
SMTP_USERNAME
SMTP_PASSWORD

# Verification email options
EMAIL_VERIFY_FROM
EMAIL_VERIFY_SUBJECT
EMAIL_VERIFY_TEMPLATE

API Doc

OpenAPI

Postman documenter(legacy)