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

https://github.com/munyabelden/blog_app

The blog application provides an intuitive and engaging platform for users to share their thoughts and ideas through blog posts, while also facilitating interaction and engagement among users through comments and likes.
https://github.com/munyabelden/blog_app

cancancan devise postgresql rails-api rails-spec rswag ruby ruby-on-rails sql

Last synced: 6 months ago
JSON representation

The blog application provides an intuitive and engaging platform for users to share their thoughts and ideas through blog posts, while also facilitating interaction and engagement among users through comments and likes.

Awesome Lists containing this project

README

          

logo

# 📗 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)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Blog App]

**[The Blog Application]** is a web-based platform that allows users to create and publish blog posts. It provides a user-friendly interface for managing blog content, including creating, editing, and deleting posts. Users can register and have their own accounts, which enable them to personalize their profile information such as name, photo, and bio. The application allows users to view and interact with blog posts by reading, commenting, and liking them.

## 🛠 Built With

### Tech Stack

- [ ] Ruby on Rails
- [ ] PostgreSql

Client

Database

### Key Features

- **[User Registration: Users can create accounts to access the application and personalize their profile]**
- **[Blog Post Creation: Users can write and publish blog posts, including a title and text content.]**
- **[User Profile: Users can update their profile information, including their name, photo, and bio.]**

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

- [ ] Visual Studio Code
- [ ] Ruby On Rails
- [ ] Ruby Gems
- [ ] Git

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/Munyabelden/Blog_App.git
```

### Install

Install this project with:

```sh
cd Blog_App
gem install/ bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
bin/rails test test/models/article_test.rb
```

### Deployment

You can deploy this project using:

- [ ] Use render or any other hosting of your choosing

(back to top)

## 👥 Authors

👤 **Belden Mugauri**

- GitHub: [@githubhandle](https://github.com/Munyabelden/)
- Twitter: [@twitterhandle](https://twitter.com/munyaradzi045)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/munyaradzi-mugauri-828a7b24a/)

👤 **Oscar Byiringiro**

- GitHub: [@githuboscar](https://github.com/byiringiroscar)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/oscar-byiringiro-9baa8313a/)

(back to top)

## 🔭 Future Features

- [ ] **[Descent UI design]**
- [ ] **[Form: for comments and like submition]**
- [ ] **[API: for posting]**

(back to top)

## 🤝 Contributing

Feel free to check the [issues page](https://github.com/Munyabelden/Blog_App/issues).

(back to top)

## ⭐️ Show your support

If you like this project feel free to give it a star
## 🙏 Acknowledgments

I would like to thank Ruby on Rails team and Microverse

(back to top)

## 📝 License

This project is [MIT](https://github.com/Munyabelden/Blog_App/blob/develop/LICENSE) licensed.

(back to top)