mimron/mimron-microservice

Manual Installation

installation manual, follow these steps:

Clone the repo:

git clone https://github.com/mimron/mimron-microservice.git
cd mimron-microservice
npx rimraf ./.git

Install the dependencies:

yarn install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Commands

Running locally:

yarn dev

Docker:

# run docker container in development mode
yarn docker:dev

Environment Variables

The environment variables can be found and modified in the .env file. They come with these default values:

# Port number
PORT=3000

#Document swagger Host
SWAGGER_HOST=localhost

# URL of the Mongo DB
MONGODB_URL=mongodb://127.0.0.1:27017/db-imron

# REDIS Connection
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

# JWT
# JWT secret key
JWT_SECRET=thisisasamplesecret
# Number of minutes after which an access token expires
JWT_ACCESS_EXPIRATION_MINUTES=30
# Number of days after which a refresh token expires
JWT_REFRESH_EXPIRATION_DAYS=30

# SMTP configuration options for the email service
# For testing, you can use a fake SMTP service like Ethereal: https://ethereal.email/create
SMTP_HOST=smtp.ethereal.email
SMTP_PORT=587
SMTP_USERNAME=jaylen.hilll22@ethereal.email
SMTP_PASSWORD=H9Ny53jCh1eXEmrhKb
EMAIL_FROM=jaylen.hilll22@ethereal.email

API Documentation

run the server and go to http://localhost:3000/v1/docs in your browser. This documentation page is using swagger.