Buttery

Requirements

You need Node.js and Postgresql installed and running. If you're running Mac OS X, it is highly recommended you install everything with Homebrew.

Technology

On the server-side, Buttery is built with hapi.js framework. Postgresql was chosen as the data store.

The front-end is built with React. We're also using a totally vanilla Flux implementation. Client-side routing is done with React Router. Gulp is used for the build pipeline.

Installation

Rename .env.example to .env.

Start your local postgresql server if you haven't already. Create a new database and save the database name in the .env file under the key DATABASE_NAME. Also modify the database credential details as needed in .env.

Install the pg module globally:

$ npm install pg -g

Then install the project's dependencies:

$ git clone git@github.com:jakechan/buttery

Running the app

npm start

This will start the app using nodemon. The script will watch for changes and will restart the app as needed.

Fire up your browser and point to http://localhost:8000/ and you will see the welcome page.