Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eccb7/pi-blogs

The Pi-Blogs is a classic example of a blog website
https://github.com/eccb7/pi-blogs

Last synced: about 1 month ago
JSON representation

The Pi-Blogs is a classic example of a blog website

Awesome Lists containing this project

README

        

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

# 📖 Pi Blogs App

The Pi Blog App will be a classic example of a blog website. I will create 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

- Client

### Key Features

- Project 1: Creating a data model.
- Project 2: Validations and Model specs.
- Project 3: Processing data in models.
- Project 4: Controllers.
- Project 5: Controllers specs.
- Project 6: Views.
- Project 7: Forms.
- Project 8: Integration specs for Views and fixing n+1 problems.
- Project 9: Add Devise.
- Project 10: Add authorization rules.
- Project 11: Add API endpoints.
Exercise: API documentation.

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- A browser of you choice.
- A text editor of your choice.
- An installed ruby gem on your local system
- Rails needs to be installed on your system

### Setup

Clone this repository to your desired folder:

- Use the following Commands:

### Install

```sh
git clone https://github.com/Eccb7/Pi-Blogs.git
```

Install dependencies:

```sh
bundle install
npm install
```

### Usage

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec
```

(back to top)

## 👥 Author

👤 **Ojwang Briton**

- GitHub: [@Eccb7](https://github.com/Eccb7)
- Twitter: [@briton_otieno4](https://twitter.com/briton_otieno4)
- LinkedIn: [briton-otieno](https://linkedin.com/in/briton-otieno)

👤 **Alier Philip Maguet**

- GitHub: [@AlierPM](https://github.com/AlierPM)
- Twitter: [@AlierPM](https://twitter.com/AlierPM)
- LinkedIn: [alierphilipmaguet](https://linkedin.com/in/alierphilipmaguet)

(back to top)

## 🔭 Future Features

- Make it mobile responsive
- Give it an admin panel.

(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

If you like this project you can reach me through [@briton_otieno4](https://twitter.com/briton_otieno4) and share more thoughts to help improve

If you like this project, give it a ⭐️.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for the support I've received so far.

(back to top)

## 📝 License

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