Haroonabdulrazaq / ror-social-scaffold

This repo includes initial code for social media app. Its purpose is to be a starting point for Microverse students.Well, it is completed by me and my partner(Luciano)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Scaffold for social media app with Ruby on Rails

It's a social media application that allows users to send friend request, accept friend request, interact like writing a post, liking a post and commenting on that post. The application is secured using Devise gem.

Built With

  • Ruby v2.7.0
  • Ruby on Rails v5.2.4
  • Postgres 12.0

Live Demo

Social-media-scaffold

Getting Started

To get a local copy up and running follow these simple example steps.

  • Fork this repository on github
  • Change directory into the repository
  • Install all gems
  • Create Database
  • Run migration

Prerequisites

Ruby: 2.6.3 Rails: 5.2.3 Postgres: >=9.5

Setup

Instal gems with:

bundle install

Setup database with:

   rails db:create
   rails db:migrate

Test

   rails spec

Github Actions

To make sure the linters' checks using Github Actions works properly, you should follow the next steps:

  1. On your recently forked repo, enable the GitHub Actions in the Actions tab.
  2. Create the feature/branch and push.
  3. Start working on your milestone as usual.
  4. Open a PR from the feature/branch when your work is done.

Usage

Start server with:

    rails server

Open http://localhost:3000/ in your browser.

Run tests

    rpsec --format documentation

Tests will be added by Microverse students. There are no tests for initial features in order to make sure that students write all tests from scratch.

Deployment

Heroku

✒️ Authors

👤 Haroon Abdulrazaq

👤 Luciano ilha carbonel

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the fork this repo and create pull request if you want to make changes.

Show your support 💪

Give a ⭐️ if you like this project!

👍 Acknowledgements

  • Microverse
  • ThOdinProject

MIT Licence ®️

MIT License

Copyright (c) 2020 Haroon Abdulrazaq

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.

About

This repo includes initial code for social media app. Its purpose is to be a starting point for Microverse students.Well, it is completed by me and my partner(Luciano)


Languages

Language:Ruby 72.8%Language:HTML 19.3%Language:SCSS 6.4%Language:JavaScript 1.3%Language:CoffeeScript 0.2%