🌱 📦 🍲 👪 Helping people buy good food at good prices, together.

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

Before we start, please install node@8 and npm@5.

git clone [email protected]:root-systems/cobuy
cd cobuy
npm run burnthemall # TODO npm install
# see 'How to get private development config' section below
npm run db migrate:latest
npm run dev

• Postgres
• git-lfs

dogstack! 🐶 🐶 🐶

We're following the dogstack folder structure convention.

Entry files:

• stories.js

Topics:

• app

Types:

• containers
• components
• helpers

Starts production server

npm start

Starts development server

npm run dev

Starts storybook server

npm run storybook

Runs ava tests

Can optionally take a glob

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

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

Checks for standard style

Can optionally take a glob

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

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

Runs knex command, with any arguments.

npm run db migrate:latest

npm run db seed:run

Anything that a developer working on Cobuy should know about.

TODO organize all the miscy mushy magic

Our development config is stored in a private repository:

cd ../
git clone [email protected]:Enspiral-Pods-Swarm/cobuy-config
cp cobuy-config/*.js cobuy/config

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

So you want to tell a story about dumb React components, ey?

Start storybook with npm run storybook

The configuration for storybook lives in .storybook/.

The stories are in ${topic}/stories/index.js. The dumb components are in ${topic}/components/${name}.js

If you add a "story", please add your topic story to .storybook/config.js

Check out app/stories/index.js for example stories, which you can copy into a new topic.

NOTE: At the moment, hot-reload does not work when changing messages in app/locales/*.json.

All numbers should be represented as strings and manipulated with bigmath.

Developers should be using British spelling in the codebase

AGPL-3.0

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