Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/zewdu444/blog_app

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/zewdu444/blog_app

orm postgresql ror ruby

Last synced: about 5 hours ago
JSON representation

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

        

# 📗 Table of Contents

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

- [📝 License](#license)

# 📰 Blog App

> 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

- ROR
- Postgresql

### Key Features

- ORM model
- User, Comment, Post, and like model
- Custom methods in each classes
- Add validation for user and post
- Test cases for each model
- Add views, controllers, and routes for each model
- Test cases for each controller
- Add views for user and posts
- Add forms for posts, comments, and likes
- Add integtation test and fix n+1 problems
- Add authentication using devise gem
- Add authorization using cancancan gem
- Add API endpoint

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

- Command line or terminal
- IDE such as VsCode.
- Rails needs to be installed on your system.

### Setup

Clone this repository to your desired folder:
Example command:

```sh
git clone https://github.com/zewdu444/blog_app.git
cd blog_app

```

### Install

Example command:

```sh
cd blog_app
bundle install (install all dependencies)

```

### Usage

To run the project redirecting to the root directory of the project and run the following command:

```sh
bin/rails server (to run web application)

```

### Test

To test the web app run the following command:

```sh
rspec spec ( to test the web application)

```

## 👥 Authors

👤 **Zewdu Erkyhun**

- GitHub: [@zewdu444](https://github.com/zewdu444)
- Twitter: [@zewdu444](https://twitter.com/zewdu444)
- LinkedIn: [zewdu-anley](https://www.linkedin.com/in/zewdu-anley/)

👤 **Marko Kermichiev**

- GitHub: [MarkoKermi](https://github.com/MarkoKermi)
- Twitter: [@MarkoKerm](https://twitter.com/MarkoKerm)
- LinkedIn: [marko-kermichiev](https://www.linkedin.com/in/marko-kermichiev/)

(back to top)

## 🔭 Future Features

- [add API documentation]

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

we would like to thank microverse community for the support and guidance.

(back to top)

## 📝 License

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

(back to top)