Code Monkey home page Code Monkey logo

live-data-server's Introduction

live-data-server

Restful CRUD API development server for frontend projects to demo.

Similar to json-server but backed by sqlite3.

npm Package Version

Features

  • No need to install (npx executable)
  • RESTful API
  • Persisted by sqlite3
  • CRUD table objects
  • CRUD key-value pairs
  • File Upload
  • Search by any field
  • Search with range / logics (TODO)

Usage

npx live-data-server [port]

The port number can be set with PORT environment variable as well, otherwise it will use any available port.

Usage Example:

> npx live-data-server 8600
listening on http://localhost:8600
listening on http://127.0.0.1:8600 (lo)
listening on http://192.168.80.105:8600 (wlp3s0)

APIs

Files API

Method Path Field
POST /files file

Collection API

Method Path Description
GET /collection/:table get all / search*
GET /collection/:table/:id get by id
POST /collection/:table create
PATCH /collection/:table/:id update by id
DELETE /collection/:table/:id delete by id

Supported Search Example:

GET /collection/user?role=admin&status=active

To-be Supported Search Example:

GET /collection/house?rent=below(5000)&area=at_least(200)
GET /collection/product?price=between(10,20)
GET /collection/user?role=not(admin)
GET /collection/user?role=any(shop,client)

Dictionary (key-value) API

Method Path Description
POST /dict/:name init by name
GET /dict/:name get by name
PATCH /dict/:name update by name
DELETE /dict/:name delete by name

Todo

  • support realtime update notices
  • support pub/sub channel

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

  • The freedom to run the program as you wish, for any purpose
  • The freedom to study how the program works, and change it so it does your computing as you wish
  • The freedom to redistribute copies so you can help others
  • The freedom to distribute copies of your modified versions to others

live-data-server's People

Contributors

beenotung avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.