ksauravsingh / json-server-deploy

Json-server acting as fake api

JSON-SERVER AS FAKE-API

JSON Server is an easy and quick-to-set-up module that you can use to fake or mock an API.

Project Structure

images/
.DS_Store
.gitattributes
.gitignore
LICENSE.md
README.md
db.json
package.json
server.js
yarn.lock

Usage (run on your machine)

Prerequisites

• Node ^14.15.4 or above
• Yarn ^1.22.19 or above

Steps

• Clone the Repository
• Install the Dependencies
• Run the Project

Clone the Repository

You can clone the repo or download the zip file.
To clone:

git clone https://github.com/KSAURAVSINGH/json-server-deploy.git

Install the Dependencies

There is only one dependency we need to install - json-server

Install json-server

yarn add json-server

Run the Project

json-server --watch db.json

You should see a file named db.json created in the folder. When you run the server locally, it tries to search for the file (db.json) and if not found, it creates a file on its own with mock JSON data.

It’ll run your server locally on http://localhost:3500
To change the PORT, go to server.js file and change the port number mentioned there.

Dependencies Used

Name	Version
json-server	^0.17.0

Visual Representation of Project

Resources

• https://blogs.sap.com/2021/01/14/how-to-create-a-fake-rest-api-with-json-server/
• https://spin.atomicobject.com/2022/06/07/api-json-server/#:~:text=JSON%20Server%20is%20an%20easy,can%20do%20with%20JSON%20Server.

Contact Me

[email protected]