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
Copy file name to clipboardExpand all lines: README.md
+1-19
Original file line number
Diff line number
Diff line change
@@ -33,9 +33,8 @@ A community-owned REST API service for testers and developers. JSON Hub provides
33
33
34
34
## Technology Stack
35
35
<ul>
36
-
<li>MongoDB</li>
37
-
<li>Express</li>
38
36
<li>NodeJS</li>
37
+
<li>Express</li>
39
38
<li>Typescript</li>
40
39
<li>CI/CD</li>
41
40
</ul>
@@ -48,23 +47,8 @@ Try it out <a target="_blank" href="https://json-hub.herokuapp.com/"> <img src="
48
47
49
48
## Installation
50
49
### 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
63
50
- Fork and clone the project
64
51
-`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.
68
52
- Run `npm run dev` to run the project in development
69
53
70
54
## Code linting and formatting
@@ -73,8 +57,6 @@ Json-hub uses Prettier + Eslint for code listing and formatting. To check if you
73
57
**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.
74
58
75
59
## 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)
78
60
- To test the endpoints provided by the application, tools such as [postman](https://www.postman.com/) can be used
0 commit comments