Baddit

App inspired on Reddit.

📑 Table of Contents

• About the project
• Technologies
• Getting started
  • Prerequisites
  • Installation
• Issues
• Contributing
• License

📃 About the Project

• Inspired by Reddit
• Can create posts, join communities, vote and comment
• Uses PostgreSQL as database
• Only authenticated users can create, comment and vote on posts
• Light and dark mode

💻 Technologies

• Ruby on Rails
• Tailwind CSS
• devise
• Hotwire

🚀 Getting Started

Prerequisites

You will need to install Ruby and Ruby on Rails

• Ruby 3.1.2
• Ruby on Rails 7
• PostgreSQL

Installation

# Clone Repository
$ git clone https://github.com/saullbrandao/baddit.git && cd baddit

# Install Gems
$ bundle install

# Run migrations
$ bin/rails db:migrate

# Run Application
$ bin/dev

This starts the development server on http://localhost:3000/

⁉️ Issues

Create a new issue report, it will be an honor to be able to help you solve and further improve our application.

📫 Contributing

• Fork this repository;
• Create a new branch to develop your feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: my new feature';
• Push to your branch: git push origin my-feature.
• Open a Pull Request

🔒 License

Distributed under the MIT License. See LICENSE for more information. Made by Saull Brandão.