README.md

AppCompass Users Service

Description

AppCompass Users Service provides users resources to a platform that uses this service's interface contract for use.

First Time Setup

For Local Development

If you use a tool like direnv to set project env vars, you don't need to run the below command. However you will need to look at the .env.example file for the env vars you need set for the service to run properly.

If you wish to use a dotenv file run the following:

$ npm run generate:dotenv

Then modify the local.env file as needed if the default values don't work for you. Specifically the database connection variables.

Once you have your environment variables set, run the following:

$ npm install
$ npm run schema:create

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

AppCompass Users Service is MIT licensed.