Ruthmy / blog-app

BlogApp | Ruby on Rails Project

📗 Table of Contents

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

---

📖 Blog App

Blog App is a Ruby on Rails-based project design for creating and managing a fully functional blog website. It allows users to create, edit, and delete posts. It also allows users to comment on posts and to like them.

These classes where made following this ERD diagram:

---

🛠 Built With

Tech Stack

The project is built using the following technologies:

• Ruby on Rails.
• PostgreSQL.
• RSpec.
• Rubocop.
• Stylelint.

---

Key Features

• Create, edit, and delete posts.
• Comment system to interact with posts.
• Like and dislike posts.
• User authentication and authorization.
• Responsive design.

Please note: Each feature will be marked with an "x" when it is fully implemented and operational.

(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:

• Installed Ruby and Ruby on 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 [e-mail]:Ruthmy/blog-app.git

Navigate to the cloned repository and run the following command to install the necessary gems:

cd blog-app
bundle install

(back to top)

Usage

Initialize it with

rails server

Then open http://localhost:3000 in your browser.

(back to top)

Test

To run the tests try the following command:

rspec spec

(back to top)

---

👥 Authors

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter @rury_exe
• LinkedIn: LinkedIn

👤 Pablo Bonasera

• Github: @PabloBona
• Linkedin: Pablo Bonasera

(back to top)

---

🔭 Future Features

• Search functionality for locating specific articles.
• User profiles with customizable avatars.
• Article categories and tagging.
• Rich text editor for formatting articles.
• Social media sharing options for articles.
• API endpoints for external integrations.

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️ if you like this project!

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)