GithubHelp home page GithubHelp logo

json-server-gui's Introduction

JSON Server GUI

What?

The json-server module starts a server exposing a dynamic REST API: any call to /somethings on your server will act like a standard REST API with no schema constraint. Checkout the project for more information.

JSON Server GUI just adds a GUI on top, based on node-webkit.

Why?

During JavaScript trainings you may want your trainees to work with a REST API (let's say, when you talk about Ajax :)). The best way would be to provide a single executable they can click on, and start experiments.

With this very simple GUI they can see the data in real time, and the requests they played. They have a direct feedback, without the need to tell them how to install a server, use a CLI, or even host your own server.

Screenshot

How?

Download

Pre-built binaries for latest version are available here:

Build

Clone the repository, then run make. The project will build for Linux (32 & 64 bits), Windows (32 bits), and Max OSX.

It can last about a century first time as it will download all corresponding node-webkit distributions.

To build specific for a specific platform:

make build-linux32
make build-linux64
make build-windows
make build-osx

Moar!

  • $APP_DIR/public is served as document root
  • $APP_DIR/db.json is your data file
  • Some behavior can be defined from environment variables:
    • APP_DIR = directory where we'll search for db.json and public folder (default = app's folder)
    • PORT = server's port (default = 26080)

TODO

  • Better GUI
  • Persisted configuration (instead of env)

How to contribute

  • Fork & clone
  • Install node-webkit for your platform (alternatively, you can run make build-<your platform> and grab node-webkit from node_modules/node-webkit-builder/cache/0.10.5/<your platform>/, saving you a duplicate download)
  • Make your changes and test them by running /path/to/nw src
  • Create a pull request

json-server-gui's People

Contributors

naholyr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

json-server-gui's Issues

Error "Unable to download nodewebkit" on "make build-osx"

cd json-server-gui
make build-osx
npm install
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No license field.
npm WARN deprecated [email protected]: WARNING: This module has been renamed to nw-builder. Install using nw-builder instead, node-webkit-builder will no longer be updated.
npm WARN deprecated [email protected]: module has been merged into crc32-stream
npm WARN engine [email protected]: wanted: {"node":"0.8.x || 0.10.x"} (current: {"node":"0.12.7","npm":"2.12.1"})
[email protected] node_modules/node-webkit-builder
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] ([email protected])
├── [email protected]
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected])
├── [email protected]
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected])
├── [email protected]
├── [email protected]
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected])
└── [email protected] ([email protected], [email protected], [email protected], [email protected])
cp ./node_modules/node-webkit-builder/bin/nwbuild ./node_modules/node-webkit-builder/bin/nwbuild.win
tr -d '\015' < ./node_modules/node-webkit-builder/bin/nwbuild.win > node_modules/node-webkit-builder/bin/nwbuild.linux
chmod +x node_modules/node-webkit-builder/bin/nwbuild.linux
cd src && npm install
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No README data
npm WARN package.json [email protected] No license field.
npm WARN deprecated [email protected]: Project has been renamed to underscore-db
[email protected] node_modules/json-server
├── [email protected]
├── [email protected]
├── [email protected] ([email protected], [email protected], [email protected])
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected])
├── [email protected]
├── [email protected] ([email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected])
└── [email protected] ([email protected], [email protected], [email protected])
no db.json
./node_modules/node-webkit-builder/bin/nwbuild.linux -p osx -o build src
Latest Version: v0.13.0
Using v0.13.0
Create cache folder in blabla/apps/json-server/json-server-gui/node_modules/node-webkit-builder/cache/0.13.0
Downloading: http://dl.node-webkit.org/v0.13.0/node-webkit-v0.13.0-osx-ia32.zip
undefined
Unable to download nodewebkit.
no db.json
ls -l
total 208
-rw-r--r-- 1 etc 2977 Sep 25 11:13 Makefile
-rw-r--r-- 1 etc 2632 Sep 25 11:13 README.md
drwxr-xr-x 4 etc 136 Sep 25 11:14 node_modules
-rw-r--r-- 1 etc 588 Sep 25 11:13 package.json
-rw-r--r-- 1 etc 92171 Sep 25 11:13 screenshot.png
drwxr-xr-x 9 etc 306 Sep 25 11:14 src

windows 10: json-server-gui does not load db.json

made dir \app moved db.json to that dir
set APP_DIR=dir, set path to json-server-gui.exe
start: json-server-gui from cli where i set APP_DIR
result: json-server-gui started at port 26080 but no db.json data is shown?

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.