Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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.
https://github.com/fmanimashaun/myblog

ruby ruby-on-rails

Last synced: 14 days ago
JSON representation

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.

Awesome Lists containing this project

README

        

# Blog App

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#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

- [x] Rails Setup
- [x] Data Model Setup
- [x] Models Created
- [x] Class Association Implemented
- [x] Custom Methods Implemented to Fetch and Manipulate Data
- [x] Models Data Validation Implemented
- [x] 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](https://git-scm.com/)
- [Ruby](https://www.ruby-lang.org/en/)
- A code editor (e.g., [VsCode](https://code.visualstudio.com/))

### Setup

Clone the repository to your local machine:

```bash
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:
```bash
rails db:create
```

4. Run migrations to set up the database schema:
```bash
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
```bash
rails s
```
2. Access the Blog app in your web browser at `http://localhost:3000`.

👆

## 👥 Authors

👤 **Fisayo Michael Animashaun**

- GitHub: [@fmanimashaun](https://github.com/fmanimashaun)
- Twitter: [@fmanimashaun](https://twitter.com/fmanimashaun)
- LinkedIn: [Fisayo Michael Animashaun ](https://linkedin.com/in/fmanimashaun)

👤 **Mahram Hossain**
- GitHub: [mhnazary](https://https://github.com/mhnazary)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mahram-hossain-nazary-515686204/)

👤 **Daniel Villalba L**
- GitHub: [@gdvl777](https://github.com/gdvl777)
- X: [@gdvl777_](https://www.x.com/gdvl777_)

👆

## 🔭 Future Features

- implement database

👆

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

[Issue Page](https://github.com/fmanimashaun/myblog/issues)

👆

## ⭐️ 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](./LICENSE) licensed.

👆