feathers-mithril-webpack-pwa-starter

A scalable, reactive example progressive messaging app.

About

This progressive web application serves as an example integration of Feathers, Flow, Mithril, Webpack 4, and Babel.

Getting Started

Prerequisites

1. Install NodeJS and Yarn.

2. Install project dependencies and run post-install scripts: yarn install:all

Development

1. Start the Feathers API server: yarn server:dev

2. Start the client development server in another terminal window: yarn client:dev

Production

1. Build the Feathers API server: yarn server:build

2. Run the production server: yarn server:production

3. Build the client: yarn client:build

4. Host and navigate to dist/client

Testing

Simply run npm test and all your tests in the test/ directory will be run.

Tips

Flow

Keep Flow types up to date

After adding new packages with yarn, run yarn update:flow to keep flow types up to date with the flow-typed community repository.

Feathers

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ yarn global add @feathersjs/cli         # Install Feathers CLI
$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers generate model                 # Generate a new Model
$ feathers help                           # Show all commands

License

© soulofmischief 2018

Licensed under the MIT license.