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

https://github.com/quavo19/social-blog


https://github.com/quavo19/social-blog

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 My Blog ](#-my-blog-)
- [🛠 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)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments \

**Social Blog** is a Ruby on Rails blog app that lets users create and publish posts, and add comments to them.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **Create post**
- **Delete Post**
- **Edit Post**

(back to top)

## 🚀 Live Demo

- not available yet

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

```
gem install rails
```

### Setup

Clone this repository to your desired folder:

```
cd my-folder
git clone https://github.com/quavo19/social-blog.git
```

### Install

Install this project with:

```sh
cd my-project
gem install
```

### Usage

To run the project, execute the following command:

```
rails server
```

### Run tests

To run tests, run the following command:

```
bin/rails test test/models/post_test.rb
```

### Deployment

You can deploy this project using:

- N/A

(back to top)

## 👥 Author

👤 **Author**

- GitHub: [@githubhandle](https://github.com/quavo19)
- Twitter: [@twitterhandle](https://twitter.com/DonaldAkite)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/donald-akite-299a31222/)

👤 **Choice Osobor**

- GitHub: [@techEmprez](https://github.com/techEmprez)
- Twitter: [@techEmprez](https://twitter.com/techEmprez)
- LinkedIn: [Choice Osobor](https://www.linkedin.com/in/choice-osobor/)

(back to top)

## 🔭 Future Features

- [ ] **Admin view**
- [ ] **Like comment**
- [ ] **Block author**

(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 please give it a ⭐️!

(back to top)

## 🙏 Acknowledgments (back to top)

## 📝 License

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

(back to top)