Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makinhs/rest-api-tutorial
This is a sample source code for the article published on Toptal: https://www.toptal.com/nodejs/secure-rest-api-in-nodejs
https://github.com/makinhs/rest-api-tutorial
expressjs expressjs-api rest-api
Last synced: about 1 month ago
JSON representation
This is a sample source code for the article published on Toptal: https://www.toptal.com/nodejs/secure-rest-api-in-nodejs
- Host: GitHub
- URL: https://github.com/makinhs/rest-api-tutorial
- Owner: makinhs
- Created: 2018-05-19T23:48:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T07:21:15.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T18:22:45.581Z (about 2 months ago)
- Topics: expressjs, expressjs-api, rest-api
- Language: JavaScript
- Homepage:
- Size: 358 KB
- Stars: 423
- Watchers: 21
- Forks: 301
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REST API Tutorial
This sample is published as part of [the corresponding article](https://www.toptal.com/nodejs/secure-rest-api-in-nodejs) 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
- Accepted changes in the docker file that was causing MongoDB issues on Windows Subsystem Linux (WSL2) - Ubuntu.
- If you are new to this project, I highly recommend starting with Typescript first, like we talk about here: https://www.toptal.com/express-js/nodejs-typescript-rest-api-pt-1