Slush-wrekr NPM

Slush wrekr

A slush generator to scaffold building with webpack, react, express, knex and redux

Getting Started

If you haven't already, install slush globally:

$ npm install -g slush

Install slush-wrekr globally:

$ npm install -g slush-wrekr

Usage

Create a new folder for your project:

$ mkdir my-slush-wrekr

Run the generator from within the new folder:

$ cd my-slush-wrekr && slush wrekr

What you should know once you have run the generator

This generator is designed to scaffold the use of several technologies to create a one-page app. The key techs are webpack, express, knex, SQLite, react and redux. It is also set up to use PostgreSQL in production.

This generator sets up both the front- and back-end infrastructure. Once you have generated the scaffold, see below for what you should know:

Some notes about scripts

The package.json file comes with several prebuilt scripts to allow for easy running of the app.

In development

You should start with running the start script:

$ npm run start

This sets up the api server on port 3000.

Next run in a new tab:

$ npm run dev

This sets up the dev server on port 8080. Open your browser to localhost:8080 to enjoy automatic bundling and hot browser reloads while you develop. Note this only applies to your front-end assets (those in the src folder). Any edits to files outside of the src folder will require you to restart the api server by running the start script again, before those changes will be seen.

An alternative development mode is to run the start script followed by:

$ npm run watch

This allows you to develop on localhost:3000 with automatic bundling but you will have to manually refresh the browser. It is preferrable to ignore this command and develop using the webpack dev server on port 8080 by running the dev script instead.

In production

Before running the start script, you will have to build the bundle file. Do this by running:

$ npm run build

Then run:

$ npm run start

Building the database

Once you have created your migration and seed files, you will need to migrate your tables and seed the database. You can do this by running:

$ npm run database

This command starts by rolling back previous migrations, so you can use this command to reset your database back to its initial seed condition or to add changes to your database. You should do this both in development and production before starting your servers.

Some notes about the architecture

The slush-wrekr generator scaffolds the architecture for a one-page app. It assumes you will serve one static page, index.html, and that you will not be using server-side routing to redirect to other pages. All routing and view-rendering is done on the client-side with react. These files are stored in the src folder which is where all your front-end assets should go.

Client-side persistence is achieved through redux. Server-side persistence is achieved through a SQLite database in development and a PostgreSQL database in production. You should use the index.js file in the api/ folder for your json api routes that communicate with the database. In the api/utils/ folder is a connection.js file that requires in knex for connection with the database. This should be required into any files that want to access the database.

The api/utils/ folder is to provide storage for your back-end modules. Front-end modules should go in the src/utils/ folder.

Note, there are two webpack configurations; one for development, and one for production.

The server is set up to use express sessions. Note, the default express sessions memory store is not suitable for production as it leaks memory (see the docs on the express-session npm module.) You will have to require in an alternative memory store (see the express-session docs for suggestions).

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

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.