Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mefengl/json-server-vercel-starter
maybe the best db server you can get
https://github.com/mefengl/json-server-vercel-starter
Last synced: 8 days ago
JSON representation
maybe the best db server you can get
- Host: GitHub
- URL: https://github.com/mefengl/json-server-vercel-starter
- Owner: mefengl
- Created: 2023-03-22T13:28:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-18T02:29:08.000Z (over 1 year ago)
- Last Synced: 2024-10-17T08:34:36.046Z (21 days ago)
- Homepage: https://json-server-vercel-starter.vercel.app
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON Server on Vercel
[](https://github.com/mefengl/made-by-ai)
This repository is a template for deploying a JSON Server on Vercel. JSON Server provides a quick and easy way to set up a RESTful API for development and prototyping purposes.
## Features
- Deploy a RESTful API in minutes
- Perform CRUD operations on your data
- Easily extendable and customizable
- Auto-generated API documentation
## Prerequisites
- Node.js (version 12 or later)
- npm (Node Package Manager)
- Vercel CLI
## Getting Started
To get started, click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmefengl%2Fjson-server-vercel-starter)
Or, follow these steps:
1. Click the "Use this template" button at the top of this GitHub repository to create a new repository with this template.
2. Clone your new repository to your local machine:
```shell
git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name
```
3. Install the JSON Server package as a dependency:
```shell
npm install
```
4. Start the JSON Server locally by running the following command:
```shell
npm start
```
5. Your local JSON Server will be running at `http://localhost:3000`. You can access your API endpoints, such as `http://localhost:3000/posts`.
6. Deploy your JSON Server to Vercel by running the following command:
```shell
vercel
```
7. Follow the prompts to complete the deployment. You'll receive a unique URL for your deployed JSON Server, which you can use to access your API endpoints.
## Usage
Once your JSON Server is deployed, you can interact with your API using different HTTP methods to perform CRUD operations on your data. Here are some examples:
1. Get all posts: Send a GET request to `https://your-unique-url.vercel.app/posts`.
2. Get a specific post: Send a GET request to `https://your-unique-url.vercel.app/posts/1`.
3. Create a new post: Send a POST request to `https://your-unique-url.vercel.app/posts` with the post data in the request body.
4. Update a post: Send a PUT request to `https://your-unique-url.vercel.app/posts/1` with the updated post data in the request body.
5. Delete a post: Send a DELETE request to `https://your-unique-url.vercel.app/posts/1`.
Please note that the deployed JSON server on Vercel is a read-only server. Any changes made to the data using POST, PUT, or DELETE requests will not persist across deployments.
## License
This project is released under the MIT License. See [LICENSE](LICENSE) for details.