ungoldman / dogstack-handbook

documentation for the dogstack framework

dogstack

🐶 🐶 🐶 a popular-choice grab-bag framework for teams working on production web apps

🐱 see also catstack, dogstack's smarter, slimmer, more cunning partner in crime

features

• provides generators for scaffolding apps made of popular libraries
• abstracts away the app plumbing that you don't want to write again, and let's you focus on features
• prescribes enough opinion to reduce friction for your team
• is omakase, modules are hand-picked by expert chefs to deliver a consistent taste throughout

examples

• dogstack.herokuapp.com: dogstack/example deployed to heroku

modules

• user interface
  • view components: react
  • view component tests: enzyme
  • view styles and themes: fela
  • state store: redux
  • data selectors: reselect
  • action / reducer helpers: redux-actions
  • async actions / effects: ??? (redux-thunk or redux-loop or redux-observable or ...)
  • client actions: feathers-action
  • router: react-router
  • authentication: redux-auth-wrapper
  • forms: redux-form
  • logging: redux-logger
• data
  • manipulation: ramda
  • schemas: tcomb
• data services
  • services: feathers
  • authentication: feathers-authentication
  • configuration: feathers-configuration
  • emailer: nodemailer
  • client transport: feathers-primus
  • database adapter: feathers-knex
• server
  • logging: pino-http
  • browser bundler: browserify
  • browser bundle server: TODO [uify]
• database
  • [Postgres]
• command-line interface
  • task runner: gulp
  • prompts: inquirer
  • file transformer: gulp
• tests
  • linter: standard
  • test runner: ava
  • executable specifications: cucumber
  • headless browser: electron
• dev tools
  • transpiler: babel
  • git hooks: husky
  • release versioning
  • changelog helpers
  • documentation helpers
• ops tools
  • process management: ??? (pm2 or docker)
  • crash reporting:

distributions

• TODO user interface
• TODO universal user interface
• TODO data services
• TODO full stack (ui + services)
• TODO mobile using [react-native]
• TODO desktop using [electron]

guides

• TODO how to install node.js and package manager
• TODO how to create a new dogstack app
• TODO how to setup a Postgres database
• TODO how to do authentication for your app
• TODO how to do styled components
• TODO how to create real-time data services
• TODO how to do authorization for your app
• TODO how to deploy your app
• TODO how to test your app using executable specifications
• TODO how to setup scheduled server tasks
• TODO how to send emails from your app
• TODO how to do a payment in your app

other opinions

• TODO pluralize by adding 's', no exceptions

prior art

• architecture by @ahdinosaur on previous private projects
• https://github.com/jlongster/react-redux-universal-hot-example0
• https://github.com/react-boilerplate/react-boilerplate
• general discussions with teammates