@bahmutov/parcel-json-server

Combination of ParcelJs bundler and json-server

Install

Requires Node 10+ because of ParcelJS bundler

npm i -D @bahmutov/parcel-json-server

Use

• create a JSON file to server as a database / REST api, see json-server documentation. For example see test/data.json
• have an HTML with JavaScript, CSS, etc. for Parcel bundler to process and serve, for example see test/app/index.html
• run parcel-json-server --entrypoint <path to HTML file> --database <path to JSON file> and get the app running at localhost:<port> with REST endpoints at localhost:<port>/<resource name>

Options

$ node ./src/cli.js --help
  Usage: cli.js [options] [command]

  Commands:
    help     Display help
    version  Display version

  Options:
    -d, --database    database JSON filename
    -e, --entrypoint  HTML filename to serve
    -h, --help        Output usage information
    -p, --port <n>    Port to run on (defaults to 3000)
    -v, --version     Output the version number

Example

In this repo the example npm start script runs

$ @bahmutov/parcel-json-server \
    --port 3000 \
    --entrypoint test/app/index.html \
    --database test/data.json

Then I can open localhost:3000 and see the application, and make calls to localhost:3000/todos (full REST endpoint)

To reset data, use POST /reset request, pass new data to overwrite ALL old data. For example, from a Cypress test cypress/integration/spec.js you can do the following

const todos = require('../../test/data.json').todos

it('responds from REST API', () => {
  cy.request('POST', '/reset', { todos })
  cy.request('/todos')
    .its('body')
    .should('deep.equal', todos)
})

Debugging

If you want to see debug messages, run with environment variable

DEBUG=@bahmutov/parcel-json-server

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2019

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2019 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.