fmanimashaun / myblog

The Blog app is a classic example of a blog website designed by ruby on rails with a database by PostgreSQL. I have created a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

Blog App

📗 Table of Contents

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

📖 Blog App

The Blog app is a classic example of a blog website designed by ruby on rails with a database by PostgreSQL. I have created a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Programming Language

• Ruby 3.2.2

Web Application Framework

• Rails 7.1.2

Database

• PostgreSQL (pg gem)

Web Server

• Puma

JavaScript Modules

• ESM Import Maps (importmap-rails gem)

Hotwire

• Turbo (turbo-rails gem)
• Stimulus (stimulus-rails gem)

APIs

• Jbuilder

Performance Optimization

• Bootsnap

Testing

• Debug
• Capybara
• Selenium Webdriver
• RSpec (rspec-rails gem)

Code Quality

• Rubocop

Development Tools

• Web Console

Key Feature

• Rails Setup
• Data Model Setup
• Models Created
• Class Association Implemented
• Custom Methods Implemented to Fetch and Manipulate Data
• Models Data Validation Implemented
• Models Unit Testing Applied

👆

💻 Getting Started

To get started with the project, follow the steps below.

Prerequisites

To run this project, ensure you have the following installed:

• Git
• Ruby
• A code editor (e.g., VsCode)

Setup

Clone the repository to your local machine:

git clone https://github.com/fmanimashaun/myblog.git

cd myblog

bundle install

Database Setup

This application uses PostgreSQL as the database. Here are the steps to set it up:

1. Ensure PostgreSQL is installed on your machine and running.

2. Update the config/database.yml file with your PostgreSQL username and password in the default section.

3. Create the database:

rails db:create

4. Run migrations to set up the database schema:

rails db:migrate

Usage

To run the program, you can use a Ruby interpreter. For example, to interact with the code, use the following:

1. Start the server

rails s

2. Access the Blog app in your web browser at http://localhost:3000.

👆

👥 Authors

👤 Fisayo Michael Animashaun

• GitHub: @fmanimashaun
• Twitter: @fmanimashaun
• LinkedIn: Fisayo Michael Animashaun

👤 Mahram Hossain

• GitHub: mhnazary
• LinkedIn: LinkedIn

👤 Daniel Villalba L

• GitHub: @gdvl777
• X: @gdvl777_

👆

🔭 Future Features

• implement database

👆

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Issue Page

👆

⭐️ Show your support

If you like this project leave a start for it.

👆

🙏 Acknowledgments

I'd like to thank Microverse for helping us in the journey to become a Fullstack developer.

👆

📝 License

This project is MIT licensed.

👆