wip

Author: typicode

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@typicode",
+  "env":{
+    "browser": true,
+    "node": true
+  }
+}

LICENSE

@@ -0,0 +1,44 @@
+Fair Source License, version 0.9
+
+Copyright (C) 2023-present typicode
+
+Licensor: typicode
+
+Software: json-server
+
+Use Limitation: 2 users
+
+License Grant. Licensor hereby grants to each recipient of the
+Software ("you") a non-exclusive, non-transferable, royalty-free and
+fully-paid-up license, under all of the Licensor's copyright and
+patent rights, to use, copy, distribute, prepare derivative works of,
+publicly perform and display the Software, subject to the Use
+Limitation and the conditions set forth below.
+
+Use Limitation. The license granted above allows use by up to the
+number of users per entity set forth above (the "Use Limitation"). For
+determining the number of users, "you" includes all affiliates,
+meaning legal entities controlling, controlled by, or under common
+control with you. If you exceed the Use Limitation, your use is
+subject to payment of Licensor’s then-current list price for licenses.
+
+Conditions. Redistribution in source code or other forms must include
+a copy of this license document to be provided in a reasonable
+manner. Any redistribution of the Software is only allowed subject to
+this license.
+
+Trademarks. This license does not grant you any right in the
+trademarks, service marks, brand names or logos of Licensor.
+
+DISCLAIMER. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OR
+CONDITION, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. LICENSORS HEREBY DISCLAIM ALL LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE.
+
+Termination. If you violate the terms of this license, your rights
+will terminate automatically and will not be reinstated without the
+prior written consent of Licensor. Any such termination will not
+affect the right of others who may have received copies of the
+Software from you.

README.md

@@ -0,0 +1,112 @@
+# json-server
+
+[![Node.js CI](https://github.com/typicode/json-server/actions/workflows/node.js.yml/badge.svg)](https://github.com/typicode/json-server/actions/workflows/node.js.yml)
+
+## Usage
+
+Install `json-server`
+
+```shell
+npm install json-server
+```
+
+Create a `db.json` file or run `json-server db.json` to create one with some default resources
+
+```json
+{
+  "posts": [
+    { "id": "1", "title": "string" },
+    { "id": "2", "title": "some post" }
+  ],
+  "comments": [
+    { "id": "1", "text": "some text", "postId": "1" },
+    { "id": "2", "text": "some text", "postId": "1" }
+  ]
+}
+```
+
+```shell
+json-server db.json
+```
+
+Run `json-server --help` for a list of options
+
+## Routes
+
+```
+GET    /posts
+GET    /posts/:id
+POST   /posts
+PUT    /posts
+DELETE /posts/:id
+```
+
+## Params
+
+### Comparison
+
+- ` ` →`==`
+- `lt` → `<`
+- `lte` → `<=`
+- `gt` → `>`
+- `gte` → `>=`
+- `ne` → `!=`
+
+```
+GET /posts?views_gt=9000
+```
+
+### Range
+
+- `start`
+- `end`
+- `limit`
+
+```
+GET /posts?_start=10&_end=20
+GET /posts?_start=10&_limit=10
+```
+
+### Paginate
+
+- `page`
+- `per_page` (default = 10)
+
+```
+GET /posts?_page=1&_per_page=25
+```
+
+### Sort
+
+- `_sort=f1,f2`
+
+```
+GET /posts?_sort=id,-views
+```
+
+### Nested fields
+
+- `x.y.z`
+
+### Include
+
+```
+GET /posts?_include=comments
+GET /comments?_include=post
+```
+
+## Delete
+
+```
+DELETE /posts/1
+DELETE /posts/1?_include=comments
+```
+
+# Serving static files
+
+If you create a `./public` directory, JSON Serve will serve its content in addition to the REST API. You can add custom directories using `-s/--static` option.
+
+```sh
+json-server -s ./static
+json-server -s ./static -s ./node_modules
+```