Technologies Used

• NodeJs https://nodejs.org/en/
• Typescript https://www.typescriptlang.org/
• Express https://github.com/expressjs/express
• Docker and Docker-Compose https://www.docker.com/
  • Postgresql https://www.postgresql.org/
  • Redis https://redis.io/
• and other auxiliaries...

Run Project

It is necessary to have docker and docker-compose installed on your machine, and for that you just access the official documentation for installation and select your operating system, after that just run the commands below.

• Clone the repository git clone git@github.com:vagnercardosoweb/nodejs-structure-with-typescript.git -b main
• Access the folder cd nodejs-structure-with-typescript
• Copy .env.example to .env.local and change the values according to your needs.
• Create Db Volume docker volume create --name=app-postgres
• Run server with docker npm run dev:docker

The port 3000 is based on env.DOCKER_PORT, by default it is 3000, if you want to change it, just change the value of the environment variable.

after step up your server will be online on host http://localhost:3000

Run migrations

Before the steps below, you must generate the build with the npm run build command if it is not a production build.

If the environment variable DB_MIGRATION_ON_STARTED is set to true as migrations will be automatically executed when starting the server, otherwise you can run manually with the command NODE_ENV={value} npm run db:migration:up.

The value of {value} must be the name of the env file configured based on .env.{value}, If the variables are already configured for the environment, just run the npm run db:migration:up command.

To rollback migrations, simply run the command npm run db:migration:down:last to undo the last operation, or npm run db:migration:down:all to undo all operations.

Run unit tests

• npm run test:unit:all to run all tests once
• npm run test:unit:coverage to run all tests and generate test coverage report
• npm run test:unit:watch to run all tests and watch for changes to files

Run integration tests

• npm run test:e2e:all to run all tests once
• npm run test:e2e:coverage to run all tests and generate test coverage report
• npm run test:e2e:watch to run all tests and watch for changes to files