Skip to content

Prodigy JSON Server is a fake REST API built with json-server for simulating product data management. It's designed to work with the Prodigy Manager app, allowing local testing of CRUD operations without a real database.

Notifications You must be signed in to change notification settings

devddine/prodigy-json-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Prodigy JSON Server

Status GitHub Issues GitHub Pull Requests License


🌱 This repository provides a fake JSON server based on the json-server package. It is used to simulate a product management API for testing purposes with the Prodigy Manager application.

Table of Contents

🌟 Features

  • Fake REST API: Simulates a REST API with endpoints for managing product data (CRUD operations).
  • No Configuration Needed: The server runs using the default configuration from json-server.
  • JSON Database: Store product data in a simple JSON file.
  • Easy Setup: Quickly set up a local server to test the Prodigy Manager app.

🛠️ Installation

  1. Clone this repository:

    git clone https://github.com/devddine/prodigy-json-server.git
  2. Navigate to the project directory:

    cd prodigy-json-server
  3. Install the required dependencies:

    npm install
  4. Start the JSON server:

    npx json-server -p 3030 ./json/database.json
  5. The server will be running at http://localhost:3030. You can now interact with the API and use it for testing the Prodigy Manager application.

📚 Usage

Once the server is running, you can:

  • Access the product data via http://localhost:3030/products.
  • Use the endpoints to GET, POST, PUT, and DELETE product data.

🚀 How to Use with Prodigy Manager

To use this fake JSON server with Prodigy Manager:

  1. Clone the Prodigy Manager repository.
  2. Follow the instructions in the Prodigy Manager README to set up the app.
  3. Make sure the Prodigy Manager app points to http://localhost:3030 for API requests.

🤝 Contributions

Feel free to contribute by submitting issues or pull requests. Your contributions are always welcome!

📜 License

This project is open-source and available under the MIT License. See the LICENSE file for more information.

About

Prodigy JSON Server is a fake REST API built with json-server for simulating product data management. It's designed to work with the Prodigy Manager app, allowing local testing of CRUD operations without a real database.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published