Welcome to @animate ✨
Thanks for getting involved with animate development!
🚧 The project is totally new, expect change 🚧
This project uses
- Lerna to manage multiple libs
- Storybook for a great development experience
- docz for documentation
- Jest for painless testing.
Before doing anything else, run these commands:
git clone firstname.lastname@example.org:hanford/animate.git cd animate yarn install yarn bootstrap yarn build
Root Repo Scripts:
yarn bootstrap # bootstraps lerna so all dependencies get # linked for cross-component development yarn start # starts storybook server yarn test # runs tests in all packages yarn build # builds all packages yarn release # publishes changed packages
Running / Writing Examples
First do the steps in "Getting started", then start the Storybook server:
Next, put a file in
packages/<component-dir>/examples/<name>.example.js and make it look like this:
import React from "react"; // The name of the example, you must export it as `name` export let name = "Basic"; // The example to render, you must name it `Example` export let Example = () => <div>Cool cool cool</div>;
Now you can edit the files in
packages/* and storybook will automatically reload your changes.
Note: If you change an internal dependency you will need to run
yarn build again. For example, if working on
MenuButton requires a change to
Rect (an internal dependency of
MenuButton), you will need to run
yarn build for the changes to
Rect to show up in your
Running / Writing Tests
First do the steps in "Getting Started", then:
Or if you want to run the tests as you edit files:
yarn test --watch
Often you'll want to just test the component you're working on:
cd packages/<component-path> yarn test --watch
Questions? Feedback? Please let me know
WWWWWW||WWWWWW W W W||W W W || ( OO )__________ / | \ /o o| MIT \ \___/||_||__||_|| * || || || || _||_|| _||_|| (__|__|(__|__|
Copyright © 2017-present Jack Hanford, email@example.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.