https://github.com/noclocks/demo-jsonserver
Demo Repository with a JSON Server Backend
https://github.com/noclocks/demo-jsonserver
Last synced: 6 months ago
JSON representation
Demo Repository with a JSON Server Backend
- Host: GitHub
- URL: https://github.com/noclocks/demo-jsonserver
- Owner: noclocks
- License: unlicense
- Created: 2024-05-03T19:21:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T21:59:34.000Z (about 2 years ago)
- Last Synced: 2024-05-04T20:53:05.423Z (about 2 years ago)
- Language: HTML
- Size: 983 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Demo JSON Server
> [!NOTE]
> Access the fake REST API at .
> [!NOTE]
> This is a demo project that uses [JSON Server](https://my-json-server.typicode.com/) to create a fake REST API for
> prototyping and testing.
## Contents
- [Demo JSON Server](#demo-json-server)
- [Contents](#contents)
- [Introduction](#introduction)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This is a demo project that uses [JSON Server](https://my-json-server.typicode.com/) to create a fake REST API for
prototyping and testing.
To accomplish this, the following steps were taken:
1. Created this repository
2. Added a `db.json` file with some data
3. Automatically deployed to
## Project Structure
> [!NOTE]
> Note that this project implements the deployment above while also providing a local development environment.
The project structure is as follows:
- [`db.json`](./db.json): A JSON file that contains the data for the fake REST API.
- [`package.json`](./package.json): A Node.js package file that contains the dependencies and scripts for the project.
## Contributing
Contributions are welcome! Please feel free to submit a pull request if you have any improvements or suggestions.
## License
This project is licensed under the [Unlicense](./LICENSE.md).
***
(c) [No Clocks, LLC](https://githubc.com/noclocks) | 2024