Skip to content

makinhs/rest-api-tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8722596 · Sep 27, 2021

History

40 Commits
Sep 9, 2020
Aug 27, 2021
Sep 9, 2020
Sep 13, 2019
Sep 8, 2020
Nov 13, 2020
Nov 14, 2020
Sep 13, 2019
Sep 27, 2021
Sep 27, 2021
Sep 27, 2021

Repository files navigation

REST API Tutorial

This sample is published as part of the corresponding article at the Toptal Engineering Blog. Visit https://www.toptal.com/developers/blog and subscribe to our newsletter to read great posts!

Before using

  • Please make sure that you have:
  • Node.js installed (https://nodejs.org/)
  • MongoDB installed and running locally (https://www.mongodb.com/)
    • Using Windows, just open the terminal at where you installed mongo and run mongod.exe
  • Run npm install or yarn in your root project folder

Usage

To run the project, please use a command line the following:

  • npm start
    • It will run the server at port 3600.

2019-09-13 update

  • Refactored mongoose to a proper common service.
  • Added a Dockerfile and docker-compose configuration.

If you are familiar to docker and you have docker installed on your machine and just want to run the project without issues please do:

  • docker-compose build
  • docker-compose up
  • It will run the mongodb at port 27017 (for testing purposes only).
  • It will run the server at port 3600.

2020-02-01

I've created a 2020 version of this project using Typescript. If you might be interested on it, please check the following repository: https://github.com/makinhs/expressjs-api-tutorial

2020-09-09

  • Updated and pruned dependencies.
  • Fixed deprecation warnings.
  • Leveraged findOneAndUpdate to simplify PATCH code.
  • Changed default MongoDB server name to localhost to simplify first-time setup.
  • Checked that it works with the latest version of Node.js, 14.9.0.

2020-11-14