Skip to content

adityabisoi/json-hub

Repository files navigation

GitHub contributors Issues PRs Forks Stars Join the chat at https://gitter.im/fetch-lobby/community

A community-owned REST API service for testers and developers. JSON Hub 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.

Click here to use json-hub!

Table of Contents

Technology Stack

  • NodeJS
  • Express
  • Typescript
  • CI/CD

Installation

  • Fork and clone the project
  • cd json-hub/ and run npm install to install dependencies
  • Run npm run dev to run the project in development

Code linting and formatting

Json-hub uses Prettier + Eslint for code listing and formatting. To check if your code follows the guidelines, run npm run lint

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.

Testing

  • To test the endpoints provided by the application, tools such as postman can be used

Documentation

To understand the aim, scope and technologies used in the project, please see the documentation

Help & support

If you are stuck somewhere or do not understand what to do, feel free to reach out to mentors/ admin in the Gitter community channel.

Contribution

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.

Contributors

License

This project is licensed under the GPL V3 License - see the LICENSE.md file for details

Open Source Events

DS-ALGO-SOLUTIONS