deped-ncr-utils

Project Environment Configuration

This project utilizes environment variables for configuration. Below is a list of variables you need to set either in a .env file or in your environment:

• MONGO_URI: MongoDB connection URI.
• MONGO_DB: MongoDB database name for production.
• MONGO_DB_DEV: MongoDB database name for development.
• PORT: Port number the server should listen on.
• SECRET_KEY: Secret key for cryptographic operations.
• isDev: Boolean indicating if the environment is development (true) or production (false).
• MAILER_TRANSPORT_HOST: Hostname for mailer transport (e.g., SMTP server).
• MAILER_TRANSPORT_PORT: Port number for mailer transport.
• MAILER_TRANSPORT_SECURE: Boolean indicating if the mailer transport should use secure connection (true or false).
• MAILER_EMAIL: Email address for sending emails.
• MAILER_PASSWORD: Password for the email account.
• ACCESS_TOKEN_SECRET: Secret key for JWT access tokens.
• REFRESH_TOKEN_SECRET: Secret key for JWT refresh tokens.
• ACCESS_TOKEN_EXPIRY: Expiry time for JWT access tokens.
• REDIS_HOST: Hostname for Redis server.
• REDIS_PORT: Port number for Redis server.
• REDIS_PASSWORD: Password for Redis server (if applicable).

Setting Up

1. Clone the repository and navigate to the project directory.
2. Create a .env file in the root directory.
3. Copy the variables from this document into your .env file and set appropriate values.

MONGO_URI=mongodb://localhost:27017
MONGO_DB=default
MONGO_DB_DEV=default-dev
PORT=3001
SECRET_KEY=your_secret_key_here
MAILER_TRANSPORT_HOST=smtp.example.com
MAILER_TRANSPORT_PORT=465
MAILER_TRANSPORT_SECURE=true
MAILER_EMAIL=[e-mail]
MAILER_PASSWORD=your_email_password
ACCESS_TOKEN_SECRET=your_access_token_secret
REFRESH_TOKEN_SECRET=your_refresh_token_secret
ACCESS_TOKEN_EXPIRY=1d
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password

4. Save the .env file.

Notes

• Ensure all environment variables are correctly set before starting the application.
• For development, consider using tools like dotenv to load environment variables from a .env file automatically.