Hack Oregon Housing Project 2016-2017 Season
This is a clone of the Hack Oregon Starter kit.
- Get Node 6.5 + - I recommend using Node Version Manager:
git clone https://github.com/hackoregon/team-budget-frontend.git.
nvm install 6.9.5and
nvm use(sets your node version)
- install yarn (using yarn instead of npm for installing dependencies will help keep versions in sync more easily), and run
yarnfrom inside the repo to install dependencies.
npm start- start dev mode (watching tests + linter)
npm test- run tests
npm run coverage- run tests w/ coverage
Note: When developing, go to http://localhost:3000/collection/housing in order to see the project's index route.
Component Library in your projectUsing the
The component libary has been installed as a dependency from an npm build, make sure the version in package.json matches the latest version in the component library repo to have access to all the latest components. (https://www.npmjs.com/package/@hackoregon/component-library)
To use a component in your project, import the precompiled component from the lib folder
Example: importing the StoryCard component from the component library
Publishing to NPM
The project uses semver and will be published on NPM for consumption in civic-platform. Run the following commands sequentially:
$ npm run bump # will provide you a prompt for version bumps & automatic git tagging + tag README with current version$ npm publish # will publish to npm