/example_node_api

Node.js example API using Typescript, PostgreSQL, Docker Compose, Hexagonal arquitecture, DDD, eslint and testing with Jest

Primary LanguageTypeScript

Node DDD API Example

To see how works

First of all, create the .env file (you have the example of the .env.example file).

After starting the docker services, be sure to install the dependencies and if you want, you can run the migration to have the database structure and two registered users.

Commands

Start docker services

make up

or

docker-compose up -d

This will start the Node and PostgreSQL docker services.

If have error be sure that your local services (like postgreSQL) are stopped.

Down docker services

make down

or

docker-compose down

Run project

make run-dev

or

docker-compose exec api npm run dev

This will run nodemon with typescript in dev environment.

Run project compile

make run-start

or

docker-compose exec api npm run start

This will compile typescript in ./dist folder and run nodemon with js transpiled.

Build project

make run-build

or

docker-compose exec api npm run build

This will only compile the typscript

Install dependencies

make install

or

docker-compose exec api npm install

Run eslint

make eslint-check
make eslint-fix

or

docker-compose exec api npm run eslint:check
docker-compose exec api npm run eslint:fix

Rules for eslint are in .eslintrc.json file on root path.

Run unit test

make run-test-unit

or

docker-compose exec api npm run test:unit

Run coverage for unit test

make run-test-unit-coverage

or

docker-compose exec api npm run test:unit:coverage

Migrations

Run migrations up

make migrate-backoffice-run

or

docker-compose exec api npm run migrate:backoffice:run

Run migrations down

make migrate-backoffice-revert

or

docker-compose exec api npm run migrate:backoffice:revert

Create migrations

docker-compose exec api npx db-migrate create {name_of_migration}

Endpoints

Get all users on backoffice

Request

Method: GET

URL: http://localhost:8080/backoffice/users

Response

[
  {
    "id": "32547dd7-617a-4985-a59a-91a176e55b83",
    "name": "Iván"
  },
  {
    "id": "43ba0b24-4d0b-40f7-aa7f-1b2a3058f484",
    "name": "Nabby"
  }
]

Get one user on backoffice

Request

Method: GET

URL: http://localhost:8080/backoffice/users/32547dd7-617a-4985-a59a-91a176e55b83

Response

{
  "id": "32547dd7-617a-4985-a59a-91a176e55b83",
  "name": "Iván"
}

Create user on backoffice

Request

Method: POST

URL: http://localhost:8080/backoffice/users

Body:

{
  "name": "Iván"
}

Response

No response

Update user on backoffice

Request

Method: PUT

URL: http://localhost:8080/backoffice/users/32547dd7-617a-4985-a59a-91a176e55b83

Body:

{
  "id": "32547dd7-617a-4985-a59a-91a176e55b83",
  "name": "Other"
}

Response

No response

Delete user on backoffice

Request

Method: DELETE

URL: http://localhost:8080/backoffice/users/32547dd7-617a-4985-a59a-91a176e55b83

Response

No response