https://github.com/hackoregon/housing-frontend
Staging site for housing front-end
https://github.com/hackoregon/housing-frontend
Last synced: 9 months ago
JSON representation
Staging site for housing front-end
- Host: GitHub
- URL: https://github.com/hackoregon/housing-frontend
- Owner: hackoregon
- License: mit
- Created: 2017-02-08T04:11:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-08-11T22:38:24.000Z (almost 7 years ago)
- Last Synced: 2025-02-02T04:23:22.294Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://hacko-housing-staging.s3-website-us-west-2.amazonaws.com/
- Size: 3.31 MB
- Stars: 3
- Watchers: 20
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hack Oregon Housing Project 2016-2017 Season
This is a clone of the [Hack Oregon Starter kit](https://github.com/hackoregon/hackoregon-frontend-starter).
### Update - This repo is now a package in the civic monorepo
#### Do not make updates in this repo - for updates and changes, use (https://github.com/hackoregon/civic.git)
___
#### Guide
1. Get [Node 6.5 +](https://nodejs.org) - I recommend using [Node Version Manager](https://github.com/creationix/nvm#install-script):
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](https://yarnpkg.com/en/docs/install) (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
**Note:** When developing, go to [http://localhost:3000/collection/housing](http://localhost:3000/collection/housing) in order to see the project's index route.
#### Using the [Component Library](https://github.com/hackoregon/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 StoryCard component from the component library
```javascript
import StoryCard from '@hackoregon/component-library/lib/StoryCard/StoryCard';
```
#### Publishing to NPM
The project uses semver and will be published on NPM for consumption in civic-platform. Run the following commands sequentially:
```bash
$ 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
```