Skip to content

Commit 233c8fa

Browse files
committed
Updated packages. Modified README.md
1 parent f165fdf commit 233c8fa

File tree

3 files changed

+171
-97
lines changed

3 files changed

+171
-97
lines changed

README.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ I am looking for a good job or work contract. You can contact me directly on my
1717

1818
## Buy me a Coffee
1919

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:.
20+
If you consider my project as helpful stuff, You can appreciate 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:.
2121

2222
<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>
2323

@@ -35,7 +35,7 @@ If you consider my project as a helpful stuff, You can appriciate me or my hard
3535
- Light-weight project.
3636
- Test cases with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
3737
- Code coverage with [Istanbuljs (nyc)](https://istanbul.js.org/).
38-
- Included CI (Continuas Integration) with [Travis CI](https://travis-ci.org).
38+
- Included CI (Continuous Integration) with [Travis CI](https://travis-ci.org).
3939
- Linting with [Eslint](https://eslint.org/).
4040

4141
## Software Requirements
@@ -63,16 +63,50 @@ git clone https://github.com/maitraysuthar/rest-api-nodejs-mongodb.git ./myproje
6363
```bash
6464
cd myproject
6565
npm install
66-
npm update
6766
```
6867

6968
### Setting up environments
7069

7170
1. You will find a file named `.env.example` on root directory of project.
7271
2. Create a new file by copying and pasting the file and then renaming it to just `.env`
72+
```bash
73+
cp .env.example .env
74+
```
7375
3. The file `.env` is already ignored, so you never commit your credentials.
7476
4. Change the values of the file to your environment. Helpful comments added to `.env.example` file to understand the constants.
75-
77+
## Project structure
78+
```sh
79+
.
80+
├── app.js
81+
├── package.json
82+
├── bin
83+
│ └── www
84+
├── controllers
85+
│ ├── AuthController.js
86+
│ └── BookController.js
87+
├── models
88+
│ ├── BookModel.js
89+
│ └── UserModel.js
90+
├── routes
91+
│ ├── api.js
92+
│ ├── auth.js
93+
│ └── book.js
94+
├── middlewares
95+
│ ├── jwt.js
96+
├── helpers
97+
│ ├── apiResponse.js
98+
│ ├── constants.js
99+
│ ├── mailer.js
100+
│ └── utility.js
101+
├── test
102+
│ ├── testConfig.js
103+
│ ├── auth.js
104+
│ └── book.js
105+
└── public
106+
├── index.html
107+
└── stylesheets
108+
└── style.css
109+
```
76110
## How to run
77111

78112
### Running API server locally

0 commit comments

Comments
 (0)