Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bolah2009/social-media-clone

Facebook clone with core features of the platform, users, profiles, friending, posts, comments, news feed, and liking. Sign-in with real Facebook by using Omniauth and Devise is also implemented.
https://github.com/bolah2009/social-media-clone

facebook facebook-clone rails ruby test-coverage

Last synced: 2 months ago
JSON representation

Facebook clone with core features of the platform, users, profiles, friending, posts, comments, news feed, and liking. Sign-in with real Facebook by using Omniauth and Devise is also implemented.

Awesome Lists containing this project

README

        

[![Maintainability](https://api.codeclimate.com/v1/badges/430cd18ef631c24a0c5f/maintainability)](https://codeclimate.com/github/bolah2009/facebook-clone/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/430cd18ef631c24a0c5f/test_coverage)](https://codeclimate.com/github/bolah2009/facebook-clone/test_coverage)
[![Build](https://travis-ci.org/bolah2009/facebook-clone.svg?branch=master)](https://travis-ci.org/bolah2009/facebook-clone)
[![codecov](https://codecov.io/gh/bolah2009/facebook-clone/branch/master/graph/badge.svg)](https://codecov.io/gh/bolah2009/facebook-clone)

# PROJECT: Facebook Clone

This is the final project of the Main Rails curriculum at [Microverse](https://www.microverse.org/) - @microverseinc

- The objective is to build a facebook clone with core features of the platform – users, profiles, “friending”, posts, news feed, and “liking”. Sign-in with the real Facebook by using Omniauth and Devise is also implemented.

## 🖼️ Screenshot

![FaceBook Clone Screenshot](./docs/facebook_clone.gif)

## [Assignment link](https://www.theodinproject.com/courses/ruby-on-rails/lessons/final-project)

## 🌐 [View in broswer](https://rails-fb-clone.herokuapp.com/)

## 🛠️ Usage (Development)

### Prerequisites

> Ruby: 2.6.3
> Rails: 5.2.3

### Clone the repo and run the app.

```
git clone https://github.com/bolah2009/facebook-clone.git
cd facebook-clone
bundle install
rails db:create
rails db:migrate
rspec #run tests
rails server #run server
open localhost:3000 on browser
```

### How to run the test suite

- run tests:
> `rpsec --format documentation`
- view test coverage:
> `open coverage/index.html`

## 🤝🏾 Contributing

If you are working on adding features, PRs, or bugfixes, this section should help get you going.

1. Fork it
2. Create your feature branch
> `git checkout -b my-new-feature`
3. Make sure all tests are passing
> `bundle install`
> `rspec`
4. Commit your changes
> `git commit -am 'Add some feature'`
5. Push to the branch
> `git push origin my-new-feature`
6. Create new Pull Request

## 👨🏽‍💻 Authors

- [@Torres-ssf](https://github.com/Torres-ssf)
- [@bolah2009](https://github.com/bolah2009/)

## 🧾 TODO

- Fix Rubocop Offense in [rubocop_todo.yml](.rubocop_todo.yml)
- Improve UI/UX

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](../../issues).

## ⭐️ Show your support

Give a ⭐️ if you like this project!

## 🙏🏾 Acknowledgments

- Microverse Team

## 📝 License

[MIT licensed](./LICENSE).