rogigs / api-coin-sentry

Api of website CoinSentry

CoinSentry'sApi

Api of project CoinSentry

Authors

• @rogigs

Run Locally

Clone the project

 [e-mail]:rogigs/api-coin-sentry.git

Go to the project directory

  cd api-coin-sentry

Install dependencies

  npm install -g nodemon && npm install

Start project

  npm run start

Run Docker

Build a image

  docker build -t api-coin-sentry:1.0 .

Run container

  docker run -d -p 4000:4000 api-coin-sentry:1.0

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

  TYPEORM_USERNAME='your-username'
  TYPEORM_PASSWORD='your-password'
  TYPEORM_DATABASE='your-database'
  TYPEORM_HOST='your-host'
  TYPEORM_PORT='your-port'

  SENTRY_DSN_PUBLIC_KEY='your-dsn'
  SENTRY_PROJECT_ID='your-project-id'
  SENTRY_ORG_SLUG='your-org-slug'

  CLIENT_LOCAL='your-address-local'
  CLIENT_QA='your-address-qa'
  CLIENT_PROD='your-address-prod'

  JWT_ACCESS_TOKEN_PUBLIC_KEY='your-token'

Generate documentation

To generate documentation run the following command

  npm run docs