https://github.com/kitloong/json-server-vercel

Deploy JSON Server to Vercel
https://github.com/kitloong/json-server-vercel

deploy json-server mock-server restful-api vercel

Last synced: about 4 hours ago
JSON representation

Deploy JSON Server to Vercel

• Host: GitHub
• URL: https://github.com/kitloong/json-server-vercel
• Owner: kitloong
• License: mit
• Created: 2022-08-04T13:23:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T04:21:04.000Z (7 months ago)
• Last Synced: 2024-04-26T05:26:34.281Z (7 months ago)
• Topics: deploy, json-server, mock-server, restful-api, vercel
• Language: JavaScript
• Homepage: https://json-server-in.vercel.app
• Size: 50.8 KB
• Stars: 200
• Watchers: 2
• Forks: 377
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## Deploy JSON Server to Vercel

A template to deploy [JSON Server](https://github.com/typicode/json-server) to [Vercel](https://vercel.com), allow you to run fake REST API online!

Demo from this repository: 

1. https://json-server-in.vercel.app

2. https://json-server-in.vercel.app/api/posts

![Powered by Vercel](https://images.ctfassets.net/e5382hct74si/78Olo8EZRdUlcDUFQvnzG7/fa4cdb6dc04c40fceac194134788a0e2/1618983297-powered-by-vercel.svg)

### How to use

1. Click "**Use this template**" or clone this repository.

2. Update or use the default [`db.json`](./db.json) in the repository.

3. Sign Up or login into [Vercel](https://vercel.com).

4. From the Vercel dashboard, click "**+ New Project**" then "**Import**" your repository.

5. In the "**Configure Project**" screen, leave everything default and click "**Deploy**".

6. Wait until deployment is done, and your own JSON server is ready to serve!

## Default `db.json`

```json

{

  "posts": [

    { "id": 1, "title": "json-server", "author": "typicode" }

  ],

  "comments": [

    { "id": 1, "body": "some comment", "postId": 1 }

  ],

  "profile": { "name": "typicode" }

}

```

## Enable write operations

By default, only GET operation is allowed, thanks to the contribution by [@VicAv99](https://www.github.com/VicAv99) at [#6](https://github.com/kitloong/json-server-vercel/issues/6), we can now enable write operations as well.

You can find the example code in [`api/server.js`](./api/server.js).

## Reference

1. https://github.com/typicode/json-server

2. https://vercel.com

3. https://shadowsmith.com/how-to-deploy-an-express-api-to-vercel