Skip to content

Commit 2fdb324

Browse files
committed
Update README.md itemizing recent changes.
1 parent d212c8f commit 2fdb324

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
# REST API Tutorial
22

3-
This sample is published as part of the blog article at www.toptal.com/blog:
4-
5-
- https://www.toptal.com/nodejs/secure-rest-api-in-nodejs
6-
7-
Visit www.toptal.com/blog and subscribe to our newsletter to read great posts
3+
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!
84

95
## Before using
106

117
- Please make sure that you have:
12-
- node.js installed (https://nodejs.org/)
13-
- have mongodb installed and running locally (https://www.mongodb.com/)
8+
- Node.js installed (https://nodejs.org/)
9+
- MongoDB installed and running locally (https://www.mongodb.com/)
1410
- Using Windows, just open the terminal at where you installed mongo and run `mongod.exe`
15-
- run npm install in your root project folder
11+
- Run `npm install` or `yarn` in your root project folder
12+
1613
## Usage
1714

1815
To run the project, please use a command line the following:
19-
- npm start
16+
- `npm start`
2017
- It will run the server at port 3600.
2118

2219

@@ -35,3 +32,11 @@ If you are familiar to docker and you have docker installed on your machine and
3532
### 2020-02-01
3633

3734
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
35+
36+
### 2020-09-09
37+
38+
- Updated and pruned dependencies.
39+
- Fixed deprecation warnings.
40+
- Leveraged `findOneAndUpdate` to simplify PATCH code.
41+
- Changed default MongoDB server name to `localhost` to simplify first-time setup.
42+
- Checked that it works with the latest version of Node.js, 14.9.0.

0 commit comments

Comments
 (0)