Skip to content

Commit a9afe91

Browse files
committed
Modify README.md
1 parent a937907 commit a9afe91

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Nodejs Expressjs MongoDB Ready-to-use API Project Structure
22
A ready-to-use boilerplate for REST API Development with Node.js, Express, and MongoDB
3+
[![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)
4+
35

46
## Getting started
57

@@ -54,6 +56,7 @@ npm update
5456
2. Create a new file by copying and pasting the file and then renaming it to just `.env`
5557
3. The file `.env` is already ignored, so you never commit your credentials.
5658
4. Change the values of the file to your environment. Helpful comments added to `.env.example` file to understand the constants.
59+
5. Test cases with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
5760

5861
## How to run
5962

@@ -85,6 +88,20 @@ If you need to add more routes to the project just create a new file in `/routes
8588

8689
If you need to add more controllers to the project just create a new file in `/controllers/` and use them in the routes.
8790

91+
## Tests
92+
93+
### Running Test Cases
94+
95+
```bash
96+
npm test
97+
```
98+
99+
You can set custom command for test at `package.json` file inside `scripts` property. You can also change timeout for each assertion with `--timeout` parameter of mocha command.
100+
101+
### Creating new tests
102+
103+
If you need to add more test cases to the project just create a new file in `/test/` and run the command.
104+
88105
## Bugs or improvements
89106

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

0 commit comments

Comments
 (0)