📗 Index

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Testing
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Blog App] [Ruby On Rails]

Ruby on Rails blog app, following the MVC pattern and using Devise gem authentication system followed by CanCanCan gem authorization, this is a showcase of the power of ruby on rails, this app storages and interacts with the database, you can see the ERD (Entity Relationship Diagram) below

🛠 Built With

Tech Stack

Client

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• [MVC Pattern] Follows the MVC(Model, View, Controller) pattern which allows it to be easy to manage
• [Authentication] Counts with an authentication system using Devise Gem which allows the user to have an unique account with its own email and password, and also allows the user to edit its own profile
• [Migration of Database using Rails method] All the data storaged is actually being managed by a Database, and the migration of the database is being done using the rails method
• [Testing] All the views are being tested using RSpec and Capybara
• [Linters] It follows the rules of 2 very well knowed linters Rubocop & Stylelint, which helps to keep the code clean and easy to read
• [Gitflow] Used Gitflow as a workflow which allows to have a clean and organized version control

(back to top)

🚀 Preview

Will be implemented in the future

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 To have ruby installed with the last version of rails

Setup

Clone this repository to your desired folder:

  Run bundle install to install all the gems and dependencies

Usage

To run the project, execute the following command:

  Executing the command 'rails s' will start the server of this RoR app

Testing

To run integration tests, you have to follow these steps:

  Executing the command `bundle install` will install all the necessary dependencies to run the tests of this RoR app

  To run all the tests, execute the command 'rspec'

  To run specific the specific tests for each view, execute one of the following codes:

  Do user_index view test command: 'rspec spec/views/users/index.html.erb_spec.rb'
  Do user_show view test command: 'rspec spec/views/users/show.html.erb_spec.rb'
  Do posts_index view test command: 'rspec spec/views/posts/index.html.erb_spec.rb'
  Do posts_show view test command: 'rspec spec/views/posts/show.html.erb_spec.rb'

Deployment

No deployment necessary

(back to top)

👥 Author

👤 Alejandro Velasquez

• GitHub: @VelzckC0D3
• LinkedIn: VelzckC0D3

✨ Contributors

👤 Daniel Falcon

• GitHub: @Danfall369
• LinkedIn: Daniel Falcon

👤 Daniel Carrera

• GitHub: @Carreraprogrammer
• LinkedIn: Daniel Carrera

🔭 Future Features

• [Responsive Design] Build a fully responsive design
• [Live Demo] Deploy the app in a live server
• [User Profile] Add a user profile page

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, be pending on my profile since I'll be doing much more!

(back to top)

🙏 Acknowledgments

I would like to thanks my Microverse Team and partners for helping me to get this done.

(back to top)

📝 License

This project is MIT licensed.

(back to top)