Skip to content

Commit f165fdf

Browse files
committed
Added codacy. Modify README.md
1 parent f07a656 commit f165fdf

File tree

3 files changed

+482
-78
lines changed

3 files changed

+482
-78
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Nodejs Expressjs MongoDB Ready-to-use API Project Structure
2-
[![Author](http://img.shields.io/badge/author-@maitraysuthar-blue.svg)](https://www.linkedin.com/in/maitray-suthar/) [![GitHub license](https://img.shields.io/github/license/maitraysuthar/rest-api-nodejs-mongodb.svg)](https://github.com/maitraysuthar/rest-api-nodejs-mongodb/blob/master/LICENSE) ![GitHub repo size](https://img.shields.io/github/repo-size/maitraysuthar/rest-api-nodejs-mongodb) ![Travis (.com)](https://img.shields.io/travis/com/maitraysuthar/rest-api-nodejs-mongodb)
2+
[![Author](http://img.shields.io/badge/author-@maitraysuthar-blue.svg)](https://www.linkedin.com/in/maitray-suthar/) [![GitHub license](https://img.shields.io/github/license/maitraysuthar/rest-api-nodejs-mongodb.svg)](https://github.com/maitraysuthar/rest-api-nodejs-mongodb/blob/master/LICENSE) ![GitHub repo size](https://img.shields.io/github/repo-size/maitraysuthar/rest-api-nodejs-mongodb) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/b3eb80984adc4671988ffb22d6ad83df)](https://www.codacy.com/manual/maitraysuthar/rest-api-nodejs-mongodb?utm_source=github.com&utm_medium=referral&utm_content=maitraysuthar/rest-api-nodejs-mongodb&utm_campaign=Badge_Coverage) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b3eb80984adc4671988ffb22d6ad83df)](https://www.codacy.com/manual/maitraysuthar/rest-api-nodejs-mongodb?utm_source=github.com&utm_medium=referral&utm_content=maitraysuthar/rest-api-nodejs-mongodb&utm_campaign=Badge_Grade) ![Travis (.com)](https://img.shields.io/travis/com/maitraysuthar/rest-api-nodejs-mongodb)
33

44
A ready-to-use boilerplate for REST API Development with Node.js, Express, and MongoDB
55

@@ -11,6 +11,16 @@ This is a basic API skeleton written in JavaScript ES2015. Very useful to buildi
1111

1212
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.
1313

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+
<a href="https://www.buymeacoffee.com/36GgOoQ2f" target="_blank"><img src="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+
1424
## Features
1525

1626
- 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
2030
- Pre-defined response structures with proper status codes.
2131
- Included CORS.
2232
- **Book** example with **CRUD** operations.
23-
- Validations added.
33+
- Validations added.
2434
- Included API collection for Postman.
2535
- Light-weight project.
2636
- 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/).
2740

2841
## Software Requirements
2942

30-
- Node.js **10+**
43+
- Node.js **8+**
3144
- MongoDB **3.6+** (Recommended **4+**)
45+
3246
## How to install
3347

3448
### Using Git (recommended)
@@ -103,6 +117,16 @@ You can set custom command for test at `package.json` file inside `scripts` prop
103117

104118
If you need to add more test cases to the project just create a new file in `/test/` and run the command.
105119

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+
106130
## Bugs or improvements
107131

108132
Every project needs improvements, Feel free to report any bugs or improvements. Pull requests are always welcome.

0 commit comments

Comments
 (0)