VCard Generator

This backend repository is build using NodeJS version 18.12 and yarn version 3.3.1

Builds

run the dev build with yarn run start:dev

run production build with yarn run start:prod

To initialize the yarn SDK for VS Code run: yarn dlx @yarnpkg/sdks vscode

Dependencies

1. express
2. validator
3. dotenv
4. bcrypt
5. jose Since jsonwebtoken doesn't offer native typescript support
6. mongodb
7. rate-limiter-flexible
8. redis
9. connect-redis
10. @sendgrid/mail During the development stage
11. helmet
12. express-session

Dev Dependencies

1. typescript
2. nodemon
3. mocha
4. ts-node
5. eslint

Environment

This project uses strong type checking for environmental variables. Be sure to include all the necessary variables in your secret file. Best practice would be not to store the values in a .env file, but to use a containerization tool like docker and expose the variables via a direct stream insertion.

Required are:

• APP_NAME

Server settings

• NODE_ENV
• PORT
• SESSION_SECRET

DB settings

• MONGODB_USERNAME
• MONGODB_PASSWORD
• MONGODB_DB_NAME
• MONGODB_URI

Authentication settings

• SALT
• JWT_EXPIRES
• COOKIE_EXPIRES

REDIS settings

• REDIS_USERNAME
• REDIS_PASSWORD
• REDIS_HOST
• REDIS_PORT

SMTP settings

• SMTP_HOST
• SMTP_PORT
• SMTP_USERNAME
• SMTP_PASSWORD