Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/blog_app_prac

Blog app is a fully functional website that shows a list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/stephenkati/blog_app_prac

postgresql ruby ruby-on-rails

Last synced: 23 days ago
JSON representation

Blog app is a fully functional website that shows a list of posts and empower readers to interact with them by adding comments and liking posts.

Awesome Lists containing this project

README

        

# Blog 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)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Blog app]

**[Blog app]** is a fully functional website that shows a 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

- **[Showcase Posts]**
- **[Comments]**
- **[Likes]**

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

- Install Ruby
- Install Rails
- Install Postgresql

### Setup

Clone this repository to your desired folder:

```sh
cd Blog app
git clone https://github.com/stephenkati/blog_app_prac.git
```

### Install

Install this project with:

```sh
cd Blog app
bundle install
```
```sh
gem install rspec
```
```sh
gem install --no-document rubocop -v '>= 1.0, < 2.0' # https://docs.rubocop.org/en/stable/installation/
```
```sh
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

### Usage

To run the project, execute the following command:

- rails s

### Run tests

To run tests, run the following command:

- rubocop --color
- npx stylelint "**/*.{css,scss}"
- rspec

### Deployment

- [N/A]

(back to top)

## 👥 Authors

👤 **Author1**
*[STEPHEN KATULI]*

- GitHub: [@githubhandle](https://github.com/stephenkati)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)

## 🔭 Future Features

- [ ] **[Add call feature]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project please show support by staring ⭐️.

(back to top)

## 🙏 Acknowledgments

* I would like to thank my Microverse team and my coding partners for their support and guidance.

(back to top)

## 📝 License

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

(back to top)