Code Monkey home page Code Monkey logo

dart-json-server's Introduction

JSON Server

Launch JSON server for web and mobile apps development from CLI without complicated backend setup.

Installation

You can install the package from the command line:

$ pub global activate json_server

Usage

The CLI is named jserver.

jserver --data=<path to JSON file>

Available options you can use:

  • -d, --data: path to JSON database file. Required.
  • -h, --host: specify the IP address to serve. Default to 127.0.0.1.
  • -p, --port: specify the port to use. Default to 1711.

JSON Format

Typically, for JSON database, you need to use following structure.

{
  "API_PATH_1": RESPONSE_OBJECT_1,
  "API_PATH_2": RESPONSE_OBJECT_2,
}

API_PATH must start with a slash / to mark it as a serving path for API. RESPONSE_OBJECT: should be either Array or Object.

Examples

To start a default server, which binds to 127.0.0.1:1711, using database.json.

$ jserver -d database.json

To start server at localhost:8888 using api.json for database.

$ jserver -h localhost -p 8888 -d api.json

LICENSE

MIT @ 2019 Pete Houston.

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.