dogstack-example

an example app using the dogstack framework. 🐶 🐶 🐶

see it live at dogstack.netlify.com

deploy a new copy of the assets (html, js, css) to netlify:

and deploy a new copy of the api to heroku:

Setup
How our stack works
Stack
Folder Structure
Available Scripts
Developer Notes
License

Setup

Before we start, please

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
- browser.js
- epic.js (combines all epics)
- updater.js (combines all updaters)
- style.js
- routes.js
- 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-example

License

ISC

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

Random dog pictures provided by randomdoggiegenerator.com

root-systems/dogstack-example

dogstack-example

Table of Contents