Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/barakadanny/blog-app-ruby-on-rails


https://github.com/barakadanny/blog-app-ruby-on-rails

Last synced: about 8 hours ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run Linters](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Blog App]

> A blog application built with Ruby on Rails would allow users to create and manage their own blog posts, as well as view and interact with posts from other users.

Using the MVC architecture, the application would have a model for managing the data for each blog post (such as the title, body, and author), a view for rendering the blog posts in a user-friendly format, and a controller for handling the input and output of the application.

The application could also include features such as user authentication, allowing users to create accounts and log in to manage their own posts, and commenting, allowing other users to leave comments on posts.

**[Blog App]** is a ruby blog website.

## 🛠 Built With

### Tech Stack

> Blog App is backend project

Database

### Key Features

> We can do CRUD operations on following things:

- **Posts**
- **Comments**
- **Likes**
- **Users**

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Comming Soon 🎈]()

(back to top)

## 💻 Getting Started

> In order to start with this project do as follows :

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

`gem install rails`

### Setup

Clone this repository to your desired folder:

`git clone https://github.com/barakadanny/Blog-App-Ruby-on-Rails.git`

### Install

Install this project with:

`bundle install`

### Usage

`rails s`

### Run Linters

To run tests, run the following command:

`rubocop`

OR

`rubocop -a`

**it will automatically correct the errors**

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👨‍💻 **Baraka Danny**

- GitHub: [@barakadan](https://github.com/barakadanny)
- LinkedIn: [danny baraka](https://www.linkedin.com/in/danny-baraka-589156169/)

(back to top)

## 🔭 Future Features

> In upcoming weeks I will add some features as mentioned below

- [ ] **Processing data in models.**
- [ ] **Validations, Model specs, and n+1 problems.**
- [ ] **Integration specs for Views.**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project then please give a ⭐️ and also share your feedback using github_issues.

(back to top)

## 🙏 Acknowledgments

❤️ [RoR Documentation](https://guides.rubyonrails.org)

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)