Open Source Ecosystems

Rails Capstone Project: Twitter Redesign

Based on Twitter, the redesign is a desktop web app that allows users to share opinions and follow other users

Live Link

Objectives:

Building a RESTful application
Application of the MVC design architecture
Using Active Record associations, queries and validations
Implementing intuitive user experience and aesthetic interface

Features

On Twitter-ish, a user can sign-up with only their names and username. The photo and cover image are optional on sign up as defaults will be applied. Users can however, edit their profile and upload their preferred photos. The maximum allowable sizes are 2MB and 4MB for photo and cover image resectively. Users can share opinions and follow users. Subsequent iterations will provide pagination.

Prerequisites

Internet connection

Tools / Built With

Ruby 3.0.
Rails 6.1.3
Bootstrap 5
Node.js
Amazon AWS S3
Yarn

Getting Started

To get started with the app, clone this project by running git clone https://github.com/george-swift/twitter-ish.git
Run bundle install to install the needed packages
Run yarn install to install the dependencies
Next, migrate the database to your environment: rails db:migrate
Finally, run the test suite to verify that everything is working correctly: rails test
If the test suite passes, you are ready to run the app in a local server. Execute rails s to fire up the server
Visit http://localhost:3000/ in your browser to run the app in a local server
You can then sign up with required details
To terminate the server, enter Ctrl + C in your terminal

Testing

Unit and integration tests are implemented with Rspec
To verify these tests, run bin/rails spec
To get a verbose format of the implemented tests, run bin/rails spec SPEC_OPTS="--format=doc"