Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.38 KB

README.md

File metadata and controls

28 lines (18 loc) · 1.38 KB
Raw

Hack OR Team Homeless Front-End

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

S3 staging http://hacko-homelessness-staging.s3-website-us-west-2.amazonaws.com/

Build Status

Guide

  1. Get Node Version Manager:
  2. git clone https://github.com/hackoregon/teamHomelessness-frontend.git.
  3. 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. yarn start - start dev mode (watching tests + linter)
  6. yarn test - run tests
  7. yarn run coverage - run tests w/ coverage

Using the Component Library in your project

The component libary 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 compoenent from the component library

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