Skip to content

amyj0rdan/acebook-plaicebook

 
 

Repository files navigation

PlaiceBook

Build Status Maintainability Test Coverage

Visit PlaiceBook on Heroku

Project description | Team learning documentation | Team presentation slides

Getting started | Running tests | Usage | How to contribute | How we deployed

Project description

This is a team project to build a clone of Facebook using Ruby on Rails. The original repo can be found here. This project was built using Agile practices and was the first time all members of the team had worked with Rails.

PlaiceBook was built by Henry Gambles, Amy Jordan, Matt Thompson and Evelyn Blázquez.

Team learning documentation

Screenshots of our Trello board showing our progress throughout the two weeks and our learnings are saved here.

Getting started

First, clone this repository. Then:

> bundle install
> bin/rails db:create
> bin/rails db:migrate

Running tests

> bundle exec rspec # Run the tests to ensure it works

Usage

> bin/rails server # Start the server at localhost:3000

How to contribute

Follow the "fork-and-pull" Git workflow:

  • Fork this repo
  • Clone the project to your own machine
  • Commit changes to your own branch
  • Push your work back up to your fork
  • Submit a pull request so that we can review your changes

How we deployed

As none of us had deployed an app previously, we decided to use Heroku. We understood that we would have more flexibility with AWS but with Heroku we would have more 'out of the box'.

We followed this Getting Started guide from Heroku.

As we were following the fork-and-pull workflow, we felt comfortable to use CD for our project and enabled this on Day 2.

About

Makers Week 8 and 9 Engineering project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 73.6%
  • HTML 18.9%
  • CSS 6.1%
  • JavaScript 1.4%