dogstack-example

an example app using the dogstack framework. 🐶 🐶 🐶

TODO see it live at dogstack.herokuapp.com

Table of Contents

• Setup
• How our stack works
• Stack
• Folder Structure
• Available Scripts
  • npm start
  • npm run dev
  • npm test
  • npm run lint
  • npm run db
• Developer Notes
• License

Setup

Before we start, please

• install node@8 and npm@5
• install Git LFS

If you want to use this as a starting ground for your new app, simply fork this repository!

If you want to develop this example further,

git clone git://github.com/root-systems/dogstack-example
cd dogstack-example
npm install
npm run db migrate:latest
npm run db seed:run
npm run dev

Stack

dogstack! 🐶 🐶 🐶

Folder Structure

We're following the dogstack folder structure convention.

• root
  • package.json
  • server.js
  • client.js
  • actions.js (combines all actions)
  • epic.js (combines all epics)
  • updater.js (combines all updaters)
  • root.js
  • intl.js
  • style.js
  • layout.js
  • routes.js
  • store.js (combines top-level epic and updater)
  • topic (e.g. dogs)
    • dux
    • services
    • containers
    • components
    • getters
    • styles
    • util

Available Scripts

npm start

Starts production server

npm start

npm run dev

Starts development server

npm run dev

npm test

Runs ava tests

Can optionally take a glob

npm test -- './todos/**/*.test.js'

Default glob is ./**/*.test.js ignoring node_modules

npm run lint

Checks for standard style

Can optionally take a glob

npm run lint -- './todos/**/*.js'

default glob is ./**/*.js ignoring node_modules

npm run db

Runs knex command, with any arguments.

npm run db migrate:latest

npm run db seed:run

Developer Notes

Anything that a developer working on this app should know about.

After deploy: migrate on heroku!

heroku run npm run db migrate:latest --app=dogstack

License

ISC

Emoji artwork is provided by EmojiOne and is licensed under CC-BY 4.0

Random dog pictures provided by randomdoggiegenerator.com