vedantshetty / Symbook

Social Media website built using Rails

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FVCproductions

INSERT GRAPHIC HERE (include hyperlink in image)

Symbook - Facebook & Twitter Clone

Social media website built using ruby on rails for my 3rd year Software Engineering Project

Badges will go here

  • build status
  • issues (waffle.io maybe)
  • devDependencies
  • npm package
  • coverage
  • slack
  • downloads
  • gitter chat
  • license
  • etc.

Build Status Dependency Status Coverage Status Code Climate Github Issues Pending Pull-Requests Gem Version License Badges

INSERT ANOTHER GRAPHIC HERE

INSERT YOUR GRAPHIC HERE

  • Most people will glance at your README, maybe star it, and leave
  • Ergo, people should understand instantly what your project is about based on your repo

Tips

  • HAVE WHITE SPACE
  • MAKE IT PRETTY
  • GIFS ARE REALLY COOL

GIF Tools

  • Use Recordit to create quicks screencasts of your desktop and export them as GIFs.
  • For terminal sessions, there's ttystudio which also supports exporting GIFs.

Recordit

Recordit GIF

ttystudio

ttystudio GIF


Table of Contents (Optional)

If your README has a lot of info, section headers might be nice.


Installation

Clone

  • cd to the directory you want to save the application

  • Clone this repo to your local machine

    git clone https://github.com/vedantshetty/Symbook.git
    cd symbook
    

Setup

-Install the required gems using bundler

bundle install
  • Build the database schema by running the migrations
rails db:migrate

Running

  • Run the rails server using rails server

  • Optionally, you could also add mock data to test the app using rails fill:data


Features

Technical Details


Contributing

  • Symbook was built as a fun project for college and is likely to have a lot of bugs and vulnerabilities. You can help ccontributing to the source code or even by raising an issue when you notice something not work as it should.

Issues

You can raise an issue by clicking here

Pull-Requests

  • Option 1

    • 🍴 Fork this repo!
  • Option 2

    • 👯 Clone this repo to your local machine using git@github.com:vedantshetty/Symbook.git

Step 2

  • HACK AWAY! 🔨🔨🔨

Step 3


FAQ

  • How do I do specifically so and so?
    • No problem! Just do this.

Support

I am not very active on social media and may not respond for a while.


License

License

About

Social Media website built using Rails

License:GNU General Public License v2.0


Languages

Language:JavaScript 46.9%Language:CSS 42.4%Language:Ruby 7.3%Language:HTML 3.3%