This project was bootstrapped with TypeScript Express starter.
First time you need to install:
Get project dependecies
yarn install or npm install
In the project directory, you can run:
Runs the app in production mode.
Open http://localhost:3000 to view it in the browser.
Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.
Generates a build for production using TypeScript compiler.
Executes the unit tests for the project using Jest.
Detect code styling issues using ESLint. Also, includes the npm run lint:fix to fix detected issues.
The configuration variable are available at the src/configs folder. There are different configuration for development, production and test environments. The variables are the following:
env=[environment_name]
secretKey=[secret_key]
dataSource=[data_source_url]
Once the project is up and running, the docs can be available at the http://localhost:3000/api-docs
- Typescript
- Jest
- ESlint
- Passport
- Express
- Swagger
See package.json for complete list of dependencies.
To run the project using docker containers follow the steps below:
starts the containers in the background and leaves them running : docker-compose up -d Stops containers and removes containers, networks, volumes, and images : docker-compose down Modify docker-compose.yml and Dockerfile file to your source code.