A community-owned REST API service for testers and developers. Fetch provides REST API endpoints for different types of placeholders, which can be easily used during testing and development without the need for creating sample data manually.
- MongoDB
- Express
- NodeJS
- Typescript
- CI/CD
Before you setup project, make sure you have pre-commit installed on your machine. Skip the following if you have already installed.
There are 3 ways to install pre-commit package manager
- Using pip:
$ pip install pre-commit
- Using homebrew:
$ brew install pre-commit
- Using conda (via conda-forge):
$ conda install -c conda-forge pre-commit
After completing the above steps, verify your installation by running
$ pre-commit --version
There are two ways of installing the project on your local Machine 🚀
-
Using Docker
-
Conventional Setup
- Fork and clone the project
cd fetch/and runnpm installto install dependencies- Setup mongodb atlas following this tutorial
- Enter the credentials in
.env.exampleand rename it to.env. - Make sure to set
USE_DOCKER= falsein.envfile. - Install the git hook scripts
pre-commit installon terminal
- Run
npm run devto run the project in development
- The endpoint
usertestwhich follows the same schema as theusers/endpoint, must be used for testing - All other endpoints except
usertestshould involve methods which must not change the data on the server (read-only) - To test the endpoints provided by the application, tools such as postman can be used
To understand the aim, scope and technologies used in the project, please see the documentation
If you are stuck somewhere or do not understand what to do, feel free to reach out to mentors/ admin in discord.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please refer the contribution guideline before making any contribution.
|
|
This project is licensed under the GPL V3 License - see the LICENSE.md file for details