/housing-frontend

Primary LanguageJavaScriptMIT LicenseMIT

This is a starter kit for Hack Oregon front-end development using React + Redux. This is a clone of the Hack Oregon Starter kit.

Guide

  1. Get Node 6.5 + - I recommend using Node Version Manager:
  2. git clone https://github.com/hackoregon/team-budget-frontend.git.
  3. nvm install 6.9.5 and nvm use (sets your node version)
  4. install yarn (using yarn instead of npm for installing dependencies will help keep versions in sync more easily), and run yarn from inside the repo to install dependencies.
  5. npm start - start dev mode (watching tests + linter)
  6. npm test - run tests
  7. npm run coverage - run tests w/ coverage

Using the Component Library in your project

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 Header component from the component library

import Header from '@hackoregon/component-library/lib/Navigation/Header';