Micro-reddit

An app which allows users to register, then post articles and also comment other user's posts, emmulating the function of the well-known Reddit web page.

This project lets us practice model creation and their associations in order to get a full understanding of Active Record. The project itself is a CLI (Command Line Interface) of the Reddit blog.

Built With

• Ruby
• Rails
• rubocop

Getting Started

To get a local copy up and running follow these simple steps, then follow the instructions on Building with Active Record.

Prerequisites

• Ruby
• Rails
• yarn
• SQLite3
• Node.js

Setup and Install

• Open your terminal - Windows: Win + R, then type cmd | Mac: Command + space, then type Terminal
• Navigate to a directory of your choosing using the cd command
• Run this command in your OS terminal: git clone git@github.com:promise-J/micro-reddit.git to get a copy of the project.
• Navigate to the project's directory using the cd command.
• Run bundle install to install all the required gems needed for the project.
• Since DB has already been created, you need to migrate to the DB telling the rails app to establish a connection to run
• Execute rails console to load the development environment by running rails console or rails c for short.
• Run User.all to see all the users in the database.
• (optional: play around with the console by adding post and also comments for each post under various users)
• End the rails console environment by running exit(1).

Usage

All actions are executed from the Ruby Console. Users can be created as long as some validations are committed (Name must be at least 2 characters long, email 9 characters long. and password 8 characters long, and all must be unique in the whole site). Each User can post an unlimited amount of posts. Every Post has a Title (at least 2 chars long) and a Body (at least 4 chars long and 2000 chars maximum) Each Post can have an unlimited amount of Comments.

Authors

👤 Promise Johnson

• GitHub: promise-J
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 German Cobian

• GitHub: @German-Cobian
• Twitter: @GermanCobian3
• LinkedIn: @german-cobian

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse
• The Odin Project

📝 License

This project is MIT licensed.