Skip to content

README.md

Latest commit

 

History

History
32 lines (30 loc) · 945 Bytes

README.md

File metadata and controls

32 lines (30 loc) · 945 Bytes

Wishlist

A simple API, built with NodeJS, to manage new customers and their favorite products.

Getting started

  • copy .env-example to .env and edit the variables
cp .env-example .env
  • just run the containers
sudo docker-compose up --build -d

ps: The project will be started on 3000 port by default.

  • Open your browser and access the url
http://localhost:3000/api-docs/

You'll see the API endpoints documented with swagger, and you'll be able to check out the functionality.

It is worth noting that to access the default routes it is necessary to be "authenticated", and for educational purposes, provide a route to create a user:

/user

And then another route to authenticate, which will return a token:

/authenticate

This route will return a token, so put it inside the "Authorize" so we can access the protected routes.

  • To stop the containers run:
sudo docker-compose down