::::::::: :::::::::: ::: :::::::: ::::::::::: ::::::::::: :::::::: :::: :::
:+: :+: :+: :+: :+: :+: :+: :+: :+: :+: :+: :+:+: :+:
+:+ +:+ +:+ +:+ +:+ +:+ +:+ +:+ +:+ +:+ :+:+:+ +:+
+#++:++#: +#++:++# +#++:++#++: +#+ +#+ +#+ +#+ +:+ +#+ +:+ +#+
+#+ +#+ +#+ +#+ +#+ +#+ +#+ +#+ +#+ +#+ +#+ +#+#+#
#+# #+# #+# #+# #+# #+# #+# #+# #+# #+# #+# #+# #+#+#
### ### ########## ### ### ######## ### ########### ######## ### ####
Meta
Installation
$ git clone --recursive https://github.com/artsy/reaction.git
$ cd reaction
$ npm install -g yarn
$ yarn install
$ cp .env.oss .env
Instructions
-
Development of components happen in storybooks:
$ yarn start
$ open http://localhost:9001/
-
Run the tests:
$ yarn test
-
Run the tests continuously (or use vscode-jest
):
$ yarn test -- --watch
-
In vscode, run the TypeScript: Run type-checker
task and open the PROBLEMS
view to see continuous type-checker
results.
-
After updating components, be sure to deploy a new demo (sharing is caring!):
$ yarn deploy-storybook
-
When using new changes in metaphysics’ schema, be sure to update the local schema copy:
$ yarn sync-schema
-
There are some suggested VSCode extensions in .vscode/extensions.json
and additional docs at docs/vscode.md.
Deployments
Circle CI is set up to publish reaction-force in a consistent and reliable way. To update the package version and deploy it on NPM.
$ npm version <new_version>
$ git push --follow-tags
The package.json file will be updated and a commit staged. When a tag is pushed to master
, Circle CI will publish to NPM. See circle.yml and the npm docs.