README.md

📗 Table of Contents

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

📖 Blog App

Blog App is an application that allows different users to log in, make posts, and comment and like other posts.

The information is saved in a PostgreSQL database with these tables:

🛠 Built With

Tech Stack

Back-end

• Ruby on Rails
• PostgreSQL

Front-end

• HTML5
• CSS
• ERB template

Key Features

• Use of Rails framework.
• MVC architecture.
• Save and retrieve information from a PostgreSQL database.
• Devise gem.
• Capybara tests with RSpec.
• CanCanCan gem.
• Rswag gem and API documentation.
• RESTful API.

(back to top)

🚀 Live Demo

Live Demo

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need to have:

• Installed Ruby and Rails.
• If you're using Windows, have installed WSL.
• If you're using MacOS, an option is using UTM.

Setup

To clone this repository to your desired folder, run the following command:

git clone git@github.com:Luffytaro22/Blog-App.git

(back to top)

Usage

To open a local server, type the following command:

rails server

To ses the API's documentation, open the local server and go to:

/api-docs

(back to top)

Install

To install all the ruby gems, use the following command:

bundle install

After installing the gems, run this commando to create and migrate a database:

rails db:create db:migrate

(back to top)

Run tests

To run the RSpec unit tests, use the following command:

rspec

(back to top)

👥 Authors

👤 Manuel Sánchez

• GitHub: @Luffytaro22
• LinkedIn: Manuel Sánchez

👤 lRebornsl

• GitHub: @lRebornsl
• Twitter: @RebornsDev
• LinkedIn: Anthony Vásquez

(back to top)

🔭 Future Features

• Integrate a Front-end framework.
• Improve UX and UI.
• Let the users follow each other.

(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 please give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to give credits to the following:

• Microverse for this readme template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)