Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lucas-erkana/blog_app

The Blog app is a classic example of a blog website. It's a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and links to posts of their interest.
https://github.com/lucas-erkana/blog_app

ruby-on-rails

Last synced: 19 days ago
JSON representation

The Blog app is a classic example of a blog website. It's a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and links to posts of their interest.

Awesome Lists containing this project

README

        


Blog App

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Rails Blog App ](#-My-Blog-App-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 Blog App

> The Blog app will be a classic example of a blog website. It is a Microverse project where they required me to 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

Ruby On Rails

### Key Features

- **Add User, Post, Like & Comment**
- **List all Users, Posts, Likes & Comments**
- **Sign up**
- **Log in**
- **Reset Password**

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

- Mac or PC
- Code Editor (Vs Code)
- Terminal
- Install [ruby 3.2.2](https://www.ruby-lang.org/en/documentation/installation/) on your computer
- Install [rails](https://www.tutorialspoint.com/ruby-on-rails/rails-installation.htm#) on your computer
- Install [postgreSQL](https://www.postgresql.org/download/) on your computer

### Setup

Clone this repository to your desired folder:

```sh
cd your-folder
https://github.com/Lucash2022/Blog_App.git
```

### Install

Install this project with:

- GitHub Actions
- Linters
- Rubocop
- Ruby On Rails

### Usage

- Run `bundle install` in the terminal from the root folder of the project.
- Run `rails db:create` in the terminal from the root folder of the project.
- Run `rails db:migrate` in the terminal from the root folder of the project.
- Run the app with `rails c` in the terminal from the root folder of the project.
- Create a new user
```sh
User.create(name: 'Lucas', bio: 'Full stack developer from Namibia', photo: 'https://ca.slack-edge.com/T47CT8XPG-U03PBVD9PAS-26c072588661-512', posts_counter: 0)
```
- Run the server with `rails s` in the terminal from the root folder of the project.

### Test

```sh
rspec
```

(back to top)

## 👥 Authors

👤 **Lucas Erkana**

- GitHub: [@Lucash2022](https://github.com/Lucash2022)
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)
- Frontend Mentor - [@Lucash2022](https://www.frontendmentor.io/profile/Lucash2022)

👤 **Saba Ahmad**

- GitHub: [@SabaAhmad404](https://github.com/SabaAhmad404)
- LinkedIn: [Saba Ahmad](https://www.linkedin.com/in/saba-ahmad-97b938244/)

(back to top)

## 🔭 Future Features

- [ ] **Create Users**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/lucash2022/Blog-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project, please leave a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for providing the reading materials that aided me during the project development

(back to top)

## ❓ FAQ

- **Can I use this code?**

- yes, it is open source. Feel free to fork it.

- **Can I contribute to this project?**

- Contact me so I can add you as a collaborator. Alternatively you can leave an issue, it will be well appreciated.

(back to top)

## 📝 License

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

(back to top)