Skip to content

anhuiyang/acebook-team-rocket

 
 

Repository files navigation

AceBook

Build Status Maintainability Test Coverage

A two week group project to build a facebook clone using Ruby on Rails and React

  • Our application is deployed on Heroku
  • Our Trello board
  • A separate frontend app that connects to the backend of this Rails app can be found here

How to contribute to this project

See CONTRIBUTING.md

Getting started

  1. Clone this repo git clone git@github.com:Sindex42/acebook-team-rocket
  2. Change directory cd acebook-team-rocket
  3. Run bundle to install dependencies bundle install
  4. Create databases bin/rails db:create
  5. Migrate tables bin/rails db:migrate

Testing

To run the tests: bundle exec rspec

Usage

  1. Start the server bin/rails server
  2. Navigate to the following page http://localhost:3000
    1. Or to the deployed version on Heroku

Signing up

  • Users can click on a link which will take them to a signup page.
  • Fill in the form with a name, email address, and provide a password and password confirmation.
    • All fields must be present
    • Email addresses must be unique
    • Passwords must be between 6 and 10 characters long
    • Password confirmation must match the password
  • Users will be shown error messages if any of the fields are invalid

Signing in

  • Users will be redirected to the welcome page if accessing any pages relating to posts and are not signed in
  • Users will be redirected to the posts page if sign in is successful
  • Users will see a welcome message upon signing in

Posts

  • Users can see posts in reverse chronological order
  • Users can see the time and date of creation of a particular post
  • Users can update posts for a maximum of 10 mins after creation

Technologies used

Tech Description
Ruby Main backend language
Ruby on Rails Ruby web application framework
Travis CI Continuous integration running tests and linters before merging branches
Code Climate Automated code reviview for code quality and complexity
postgresql Object-relational database management system
Trello Tracking and organising workflow
SimpleCov Code coverage analysis tool for Ruby, badge provided trough Code Climate
Heroku Cloud platform hosting service
JWT JSON Web Token, for Frontend authentication tokens
Faker A library for generating fake data, used for stubbing AJAX requests
React A JavaScript library for building our frontend app

Learning log

  • To see a log of our learnings throughout this project, please refer to our project wiki

Contributors

About

Group Project - a facebook clone deployed on Heroku

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 83.3%
  • HTML 12.2%
  • CSS 2.4%
  • JavaScript 2.1%