Welcome to Chariteer!

This is the API version of the client side of Chariteer.

Overview

A group of (four) passionate students at Dev Bootcamp created Chariteer for volunteers and charity organizations to connect to build a better community.

User Stories

User Stories for Charity Organization

1. As a user, I want to be able to create a profile for my organization.
2. As a user, I want to login and create an event to connect with volunteers.
3. As a user, I want to view all the events of my organization.
4. As a user, I want to see how many volunteers have registered to volunteer at my event.

User Stories for Volunteers

1. As a user, I want to search for an event by category or event name.
2. As a user, I want to create an account to store my information and events I have registered for.
3. As a user, I want to view my profile page so that I can see my upcoming events and past events.

Technology

1. Rails - Back-end API
2. Angular.js - Front-end
3. Postgresql - Database
4. Ruby
5. Javascript
6. HTML5 and CSS3

Team

1. Teresa Nesteby
2. Gai Vien
3. Jaclyn Karnowski
4. Marisa Ramon

Team Norms/Culture

We started off this project with the following norms and agreements.

1. Check-in three times a day -- 9AM before coding, 12PM mid-day check-in, and 6PM final check-in to review and plan for the next day.
2. Be fully present whenever we are together.
3. Open and honest communication.
4. Assume the best.
5. Respect time.
6. Review and set daily goals.
7. Use trello board for project organization and slack for group communication.
8. Throw confetti -- success!!

Contributing

If you like this project and would like to contribute, please feel free to clone this repository. Please note that our client-side repository is located at Chariteer-Client-Side.

Please follow these steps to get started.

1. git clone https://github.com/TeresaNesteby/chariteer-api.git
2. bundle install
3. bundle exec rake db:create db:migrate db:seed Note that the seed is optional but this was the data that we started off with for development.
4. rails serve

Follow the steps in the client side. You will need both server to run Chariteer.