rloterh / microreddit

Rails - A mini Reddit App in rails to demonstrate Active Record

MicroReddit - RoR Active Records (Microverse Ruby on Rails Module)

Description

Micro Reddit is a console based application that demonstrate the use of Rails ActiveRecord and mimics core data models of Reddit. It involves 3 main models: User, Posts and Comments and linked via Association Relationship. The specification for this project is a part of The Odin Project.

ReadMe Directory 📙

Contents
Built With
Setup Instructions & Getting Started
Testing
Authors
License

Built With

• Ruby 2.7.2
• Rails 6.0.3.4
• SQLite 3.8.0

Setup Instructions & Getting Started

1. • Copy the git link https://github.com/rloterh/MicroReddit.git of this project
2. • In your terminal run the command git clone https://github.com/rloterh/MicroReddit.git
3. • Run the command cd MicroReddit to navigate to the cloned project directory
4. • Run the command bundle install to install dependencies
5. • Run the command rails db:create to create database
6. • Run the command rails db:migrate to configure database schema
7. • Run the command rails console
8. • Setup temporally isntance of the User, Post or Comment to test values and associations

Testing

NB: Before running test ensure rubocop andrspec gems are installed

Validating Ruby Syntax & Coding Standard

1. • Go to the terminal (directory pointing to the root of the project)
2. • Run the command rubocop
3. • Click on the check button to validate
4. • All validations should pass, when no error message is displayed in the terminal

Running Test Cases

1. • Go to the terminal (directory pointing to the root of the project)
2. • Run the command rspec
3. • To run test cases individually run the command rpsec relative_path_of_testfile
     (replace rerelative_path_of_testfile with the actual relative path to the test file you want to run)
4. • All test cases passes, when no error message is shown in the terminal

Authors

👨‍💻 Robert Loterh

👨‍💻 Akintoye Olamide

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Reddit
• The Odin Project
• Microverse

License