You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A ready-to-use boilerplate for REST API Development with Node.js, Express, and MongoDB
5
5
@@ -11,6 +11,16 @@ This is a basic API skeleton written in JavaScript ES2015. Very useful to buildi
11
11
12
12
This project will run on **NodeJs** using **MongoDB** as database. I had tried to maintain the code structure easy as any beginner can also adopt the flow and start building an API. Project is open for suggestions, Bug reports and pull requests.
13
13
14
+
## Advertise for Job/Work Contract
15
+
16
+
I am looking for a good job or work contract. You can contact me directly on my email ([maitraysuthar@gmail.com](mailto:maitraysuthar@gmail.com"maitraysuthar@gmail.com")) or you can download my CV from my personal [website](https://maitraysuthar.github.io/portfolio/). Looking forward. Thanks :smile:
17
+
18
+
## Buy me a Coffee
19
+
20
+
If you consider my project as a helpful stuff, You can appriciate me or my hard work and time spent to create this helpful structure with buying a coffee for me. I would be very thankful if you buy me a coffee, Please buy me a coffee :smile:.
21
+
22
+
<ahref="https://www.buymeacoffee.com/36GgOoQ2f"target="_blank"><imgsrc="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png"alt="Buy Me A Coffee"style="height: auto!important;width: auto!important;" ></a>
23
+
14
24
## Features
15
25
16
26
- Basic Authentication (Register/Login with hashed password)
@@ -20,15 +30,19 @@ This project will run on **NodeJs** using **MongoDB** as database. I had tried t
20
30
- Pre-defined response structures with proper status codes.
21
31
- Included CORS.
22
32
-**Book** example with **CRUD** operations.
23
-
- Validations added.
33
+
- Validations added.
24
34
- Included API collection for Postman.
25
35
- Light-weight project.
26
36
- Test cases with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
37
+
- Code coverage with [Istanbuljs (nyc)](https://istanbul.js.org/).
38
+
- Included CI (Continuas Integration) with [Travis CI](https://travis-ci.org).
39
+
- Linting with [Eslint](https://eslint.org/).
27
40
28
41
## Software Requirements
29
42
30
-
- Node.js **10+**
43
+
- Node.js **8+**
31
44
- MongoDB **3.6+** (Recommended **4+**)
45
+
32
46
## How to install
33
47
34
48
### Using Git (recommended)
@@ -103,6 +117,16 @@ You can set custom command for test at `package.json` file inside `scripts` prop
103
117
104
118
If you need to add more test cases to the project just create a new file in `/test/` and run the command.
105
119
120
+
## ESLint
121
+
122
+
### Running Eslint
123
+
124
+
```bash
125
+
npm run lint
126
+
```
127
+
128
+
You can set custom rules for eslint in `.eslintrc.json` file, Added at project root.
129
+
106
130
## Bugs or improvements
107
131
108
132
Every project needs improvements, Feel free to report any bugs or improvements. Pull requests are always welcome.
0 commit comments