noobling/anglicare-sprint-week

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# anglicare-sprint-week

[![Build Status](https://travis-ci.org/noobling/anglicare-sprint-week.svg?branch=master)](https://travis-ci.org/noobling/anglicare-sprint-week)
[![Maintainability](https://api.codeclimate.com/v1/badges/d12c82b2907f866ba297/maintainability)](https://codeclimate.com/github/noobling/Homefornow/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/318b1618e791619e310a/test_coverage)](https://codeclimate.com/github/noobling/anglicare-sprint-week/test_coverage)

## Context

This application will digitalise the youth crisis accommodation sector.
Making the process:

* less stressful
* simpler
* easier
* more efficient, reducing costs

### How we are going to do this

A simple responsive web application that allows homeless youths to easily search for available accommodation then to quickly make a booking. Accommodation providers are provided with a simple interface to enter and track their bed vacancies plus a platform to receive accommodation enquiries. 

## Getting started

* `git clone https://github.com/noobling/anglicare-sprint-week.git` Download the app
* Get the `.env` file from a team member and place it in the top level directory
* `git checkout developer`Work in developer branch
* `npm install` Get dependencies
* `npm start` Start the server
* Make your changes
* `git add .` Stage your changes
* `git commit -m "Commit message"`Save your changes
* `git push origin developer`Upload it to github
* Your changes should be there for everyone to see :)

* `npm run devstart` This runs the project using nodemon. To reset the server then use 'rs'.

* `npm run watch` This watches for frontend js changes so they can be transpiled using babel

## Developers

* Alex Arnold
* Thai Nguyen
* Ben Chidlow
* Jeremiah Pinto
* James Li
* Neosh A. Sheikh
* Abrar Amin
* Matthew Stagoll
* David Yu

## [Learn more about this app](https://github.com/noobling/anglicare-sprint-week/wiki)