Skip to content
This repository has been archived by the owner on Dec 14, 2022. It is now read-only.

ikraamg/ror-social-scaffold

 
 

Repository files navigation

hire-badge Twitter Follow

hire-badge Twitter Follow

Social Media Project

In this project, we first designed an ERD diagram which visually displays the database schema and structure. We then added a friendship functionality using self-referencial relationships to the forked repositry.Database query improvements were made ontop of the friendship funtionality OmniAuth via Twitter is enabled, allowing users to login via their twitter accounts. Friends can be added via a request. A request can be cancelled by user or rejected/confirmed by friend. 51 tests are run using rspec unit tests for the models, rspec controller tests and then capybara integration tests.

screenshot

screenshot

screenshot

Built With

  • Ruby v2.6.5
  • Ruby on Rails v5.2.4.2
  • Gems used for testing: Capybara, Rspec-Rails, Shoulda-matchers and FactoryBot, OmniAuth

Live Demo

Heroku App Link

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

  • Ruby: 2.6.3
  • Rails: 5.2.3
  • Postgres: >=9.5
  • Git

Usage

  • Fork/Clone this project to your local machine
  • Open folder in your local enviroment and run thes lines of code to get started:

Install gems with:

    bundle install

Setup database with:

   rails db:create
   rails db:migrate

Start server with:

    rails server

Then open a web page and go to port 3000 on your local machine.

Running tests

    bundle exec rpsec --format documentation

Deployment

The application was deployed on herouku. To deploy your own copy, you can follow the following steps:

Authors

👤 Ikraam Ghoor

👤 Shabab Ali

🤝 Contributing

Contributions and feature requests are welcome!

Start by:

  • Forking the project
  • Cloning the project to your local machine
  • cd into the project directory
  • Run git checkout -b your-branch-name
  • Make your contributions
  • Push your branch up to your forked repository
  • Open a Pull Request with a detailed description to the development(or master if not available) branch of the original project for a review

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

Microverse for the skeleton repository which this project was built on.

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 76.8%
  • HTML 16.1%
  • CSS 5.8%
  • JavaScript 1.1%
  • CoffeeScript 0.2%