turquoisemelon/haven.to

A team project built for improving the lives of homeless people using Ruby on Rails and React

Haven.to

This a full-stack react on rails app. It is built from scratch where a team of 3 people handled everything from concept to design and development.

Concept

The app is a content management system to collect data from the homeless. The collected data is used to map demographics of the users. Recharts http://recharts.org/ used to create data visualisations. Please sign up to navigate inside the user interface of the app. To be able to access the admin interface you need to use following credentials: username: root@user.com password: 1234

Setup

1. Clone
2. Run bundle install to install dependencies
3. cd to client folder and yarn install to work with react
4. Run bin/rake db:create
5. Run bin/rake db:migrate
6. Run bin/rake db:seed

Working with Git

Always create your own branch and never commit directly to master branch, please follow these steps:

1. Create a new branch
   git checkout -b <<your branch name>>
2. Push your branch to origin to track changes
   git push --set-upstream origin <<your branch name>>
3. Commit and push all your changes to origin as you work once you are done your feature switch to local master branch
   
4. Now go on github and generate a pull request, ask another team member to review your code and merge it to remote master
5. Once your branch is merged checkout you local master branch and pull from origin
   git checkout master
git pull origin master
6. Now delete your feature branch from origin as a clean up
   git push origin --delete <<your branch name>>
7. Finally delete your remote feature branch
   git branch -d <<your branch name>>

Working with React

You will need to install yarn https://yarnpkg.com/en/docs/install after bundle install.

run foreman start -f Procfile.dev to start both rails and react server Will listen on port :3000

Screenshots