Skip to content

Commit 6997e65

Browse files
committedSep 3, 2022
Remove mongodb dependency
1 parent 105f22e commit 6997e65

19 files changed

+48
-722
lines changed
 

Diff for: ‎.env.example

-7
This file was deleted.

Diff for: ‎Dockerfile

-7
This file was deleted.

Diff for: ‎README.md

+1-19
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@ A community-owned REST API service for testers and developers. JSON Hub provides
3333

3434
## Technology Stack
3535
<ul>
36-
<li>MongoDB</li>
37-
<li>Express</li>
3836
<li>NodeJS</li>
37+
<li>Express</li>
3938
<li>Typescript</li>
4039
<li>CI/CD</li>
4140
</ul>
@@ -48,23 +47,8 @@ Try it out <a target="_blank" href="https://json-hub.herokuapp.com/"> <img src="
4847

4948
## Installation
5049
### Project Installation
51-
52-
There are two ways of installing the project on your local Machine 🚀
53-
54-
#### Using Docker
55-
- Fork and clone the project
56-
- Install and configure your [Docker](https://www.docker.com/), following [this](https://docs.docker.com/engine/install/).
57-
- Rename `.env.example` to `.env`.
58-
- Once docker is installed run the followig commands.
59-
- `docker-compose build`
60-
- Once the build is complete, run `docker-compose up`
61-
62-
#### Conventional Setup
6350
- Fork and clone the project
6451
- `cd json-hub/` and run `npm install` to install dependencies
65-
- Setup [mongodb atlas](https://www.mongodb.com/cloud/atlas) following [this tutorial](https://dev.to/dalalrohit/how-to-connect-to-mongodb-atlas-using-node-js-k9i)
66-
- Enter the credentials in `.env.example` and rename it to `.env`.
67-
- Make sure to set `USE_DOCKER= false` in `.env` file.
6852
- Run `npm run dev` to run the project in development
6953

7054
## Code linting and formatting
@@ -73,8 +57,6 @@ Json-hub uses Prettier + Eslint for code listing and formatting. To check if you
7357
**Note :** The project uses **Husky**, a pre-commit GIT hook which checks if the code follows linting guidelines before commiting. This helps prevent unwanted linting errors in the pipelines.
7458

7559
## Testing
76-
- The endpoint `usertest` which follows the same schema as the `users/` endpoint, must be used for testing
77-
- All other endpoints except `usertest` should involve methods which **must not** change the data on the server (read-only)
7860
- To test the endpoints provided by the application, tools such as [postman](https://www.postman.com/) can be used
7961

8062
## Documentation

Diff for: ‎data/sportdata.json

-203
This file was deleted.

Diff for: ‎data/fakedata.json renamed to ‎data/userdata.json

File renamed without changes.

Diff for: ‎data/vehicledata.json

-103
This file was deleted.

Diff for: ‎docker-compose.yml

-27
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.