Skip to content

Repository files navigation

JSON Server Starter

A minimal setup for quickly starting a mock JSON API server using json-server. This project allows developers to test frontend applications or prototype API interactions with minimal backend setup.

Features

  • Simple, customizable JSON API
  • Quick setup for prototyping and testing
  • Uses json-server to simulate a full REST API

Getting Started

Prerequisites

  • Node.js and npm

Installation

  1. Clone the repository:
    git clone https://github.com/deanvons/json-server-starter.git
  2. Navigate to the directory:
    cd json-server-starter
  3. Install dependencies:
    npm install

Usage

Start the server:

npm start

Access the API at http://localhost:3000/collection-name (books etc)

Access the images http://localhost:3000/assets/image-name.png

To customizing the data simply edit db.json to customize the API data structure.

Supports CRUD HTTP

Contributing Feel free to open issues and submit pull requests.

Deployment

Will discuss in class

License This project is open-source.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages