Skip to content

Latest commit

 

History

History
85 lines (48 loc) · 1.77 KB

README.md

File metadata and controls

85 lines (48 loc) · 1.77 KB
Raw

Fuerza API

💻 About the project

This api provides a simulation of post request, listing all posts or a unique one, update a post, delete a post and is the result of a node-challenge provided by Fuerza Studio @fuerzastudio.

🚀 Technologies

Technologies that I used to develop this api

🎯 Getting started

Requirements

Clone the project and access the folder

$ git clone https://github.com/colpachi/node-challenge.git && cd fuerza-api

Follow the steps below

# Install the dependencies
$ npm install

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env

# Create the instance of mongoDB using docker
$ docker run --name fuerza-api -p 27017:27017 -d -t mongo

# make sure the services are running
$ docker container ps

# To finish, run the api service
$ npm start

# Well done, you should be good to go!

💎 Final considerations

  • You can choose your best api software tool, we recommend postman for the route testing.

  • For the tests please run:

npm test
  • You can always search the documentation available in docs folder to get in touch with the operations available in this api. Please access:
http://localhost:3000/docs/

Enjoy!

Made with ♥️  by Murilo Colpachi 👋  Here is my linkedin