https://github.com/vagnercardosoweb/nodejs-structure-with-typescript

Structure already configured to start any API in NODE with Typescript
https://github.com/vagnercardosoweb/nodejs-structure-with-typescript

Last synced: about 2 months ago
JSON representation

Structure already configured to start any API in NODE with Typescript

• Host: GitHub
• URL: https://github.com/vagnercardosoweb/nodejs-structure-with-typescript
• Owner: vagnercardosoweb
• Created: 2022-04-16T08:24:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-14T04:32:08.000Z (12 months ago)
• Last Synced: 2024-01-14T20:43:32.626Z (12 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## Technologies Used

- NodeJs [https://nodejs.org/en/](https://nodejs.org/en/)

- Typescript [https://www.typescriptlang.org/](https://www.typescriptlang.org/)

- Express [https://github.com/expressjs/express](https://github.com/expressjs/express)

- Docker and Docker-Compose [https://www.docker.com/](https://www.docker.com/)

  - Postgresql [https://www.postgresql.org/](https://www.postgresql.org/)

  - Redis [https://redis.io/](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](https://docs.docker.com/engine/install/) for installation and select

your operating system,

after that just run the commands below.

- Clone the

  repository `git clone [email protected]: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](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