git clone https://github.com/hackoregon/team-budget-frontend.git
.nvm install 6.9.5
and nvm use
(sets your node version)yarn
from inside the repo to install dependencies.npm start
- starts dev mode (watching tests + linter).npm test
- runs tests.npm run coverage
- runs tests and displays a coverage summary.The component library has been installed as a dependency from the npm build version 0.0.6 (https://www.npmjs.com/package/@hackoregon/component-library)
To use a component in your project, import the component from its source in the lib folder.
Example: Importing the Header component from the component library
import Header from '@hackoregon/component-library/lib/Navigation/Header';
If you want to make any changes, please submit a Pull Request. See the GitHub documentation, if you do not know how to do that. For example, Creating a pull request from a fork or more generally, Collaborating with issues and pull requests.
This code is based on the hackoregon-frontend-starter project, which is a template for Hack Oregon front-end development using React + Redux. The purpose of starting from that baseline is so that the different projects will share a common design.