Ruby Capstone

Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
• Quick Start
• Installation
• Testing
• Built With
• Contributing
• Author
• Acknowledgements
• 📝 License

About The Project

This is the capstone project for the Ruby on Rails section of Microverse main curriculum. This project is based on the lifestyle articles website. In this app, users can read and write articles under vrious categories. The original design for the priject can be found here.

Main Features of the App

• Users can create an account for which just entering an unique username is enough.
• Users can read and write articles under different categories.
• A user can read all articles without registering, however for writing an article, they must be registered users.
• A writer(author) can always edit or delete his/her article.
• Registered users can vote up (or vote down) an article which they like (or dislike).
• An article with highest number of votes is shown as the featured article on the home page of the app.

Live demo

Here is the live demo of my work.

Built With

• Ruby version 2.7.1
• Ruby on Rails version 6.0.3

Quick Start

Prerequisite

• Install Ruby (installation guide)
• Install Ruby on Rails (installation guide)
• Git and Github

Get a local copy with:

git clone https://github.com/praz99/ror_capstone.git

Installation

After cloning the app, enter following commands in your terminal.

bundle install

yarn install --check-files

rails db:create

rails db:migrate

rails server

Open https://localhost:3000/ in your browser

Testing

To test the project

• Navigate to the directory where the project is located.
• Open terminal in this directory.
• Start testing by using rspec command.

Contributing

Contributions, issues and feature requests are welcome! Start by:

• Fork the project.
• Clone the project to your local machine.
• cd into the project directory.
• Run git checkout -b your-branch-name.
• Make your contributions.
• Push your branch up to your forked repository.
• Open a Pull Request with a detailed description to the development branch of the original project for a review.

Author

👤 Prajwal Thapa

• LinkedIn: Prazwalthapa
• GitHub: @praz99
• E-mail: t.prazwal@gmail.com

Show your support

Give a ⭐️ if you like this project!

Acknowledgements

• Nelson Sakwa
• Microverse

License

• This project is MIT licensed.