Snippet

Snippet is an app built in Fellowship with NSW Education Centre for Education Statistics and Evaluation in 2017-18.

Snippet allows educators to view or publish insights about program applications in NSW schools.

This repository contains a web application client that is exported to an internal application at NSW Education.

Requirements

• Node 8.1.2
• npm 6.1.0
• yarn 1.7.0

We recommend using nvm to manage Node versions.

Tech

This app is built from create-react-app

• create-react-app

Data management

• Redux

UI

• Reactstrap

Mock API

• json-server

Set up

1. Use the correct Node version

nvm use

2. The first time, install dependencies:

yarn install 

3. Run the mock API:

yarn api

4. Open a second terminal window and run the app:

yarn dev

CLI Commands

# install dependencies
yarn

# serve with hot reload at localhost:8080
yarn start

# build for production with minification
yarn build

# test the production build locally
yarn serve 

# run test watcher
yarn test

# run test on individual file
yarn test store/rootReducer

# run the mock server
yarn api

# start storybook (develop UI components)
yarn storybook 

Debugging

Debug with React with React Dev Tools for Chrome.

Debug the state layer with Redux devtools extension.

Enable logging from the console with Bows.

By typing this in to the Browser Console:

localStorage.debug = true

Deploy

Deploy to the demo environment happens from CI off tag creation.

To tag a release for deployment:

git tag `date "+release-%Y%m%d%H%M%S"` && git push --tags

Rollback

To rollback a release:

git checkout -b release-20160101
git tag `date "+release-%Y%m%d%H%M%S"` && git push --tags

---

Contributing

For help on setting up the repo locally, building, testing, and contributing please see Contibuting.

Code of Conduct

All developers who wish to contribute through code or issues, take a look at the Code of Conduct.

License

MIT.