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

https://github.com/oscarfmdev/blog_app


https://github.com/oscarfmdev/blog_app

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          

# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“– blog\_app ](#-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)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [πŸ“ License ](#-license-)

# πŸ“– blog_app

**blog_app** is a website built with rails, it allows the user to make posts, like and comment posts.

## πŸ›  Built With

### Tech Stack

Programming Language

Server

Database

### Key Features

- **Allows the user to create a post**
- **Allows the user to comment a post**
- **Allows the user to like a post**

(back to top)

## πŸš€ Live Demo
Not yet available

(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 to have installed Ruby, Rails and PostgreSQL all the links are in [Tech Stack ](#tech-stack-) section.

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone git@github.com:OscarFMdev/blog_app.git
```

### Install

Install this project with:

Example command:

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

### Usage

To run the project, execute the following command:

Example command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
bin/rails test
```

### Deployment

Not yet available

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Author1: Oscar FernΓ‘ndez MuΓ±oz**

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

πŸ‘€ **Mhamad Raad**

- GitHub: [@Mhamad-Raad](https://github.com/Mhamad-Raad)
- LinkedIn: [Mhamad Raad](https://www.linkedin.com/in/mhamad-raad)

(back to top)

## πŸ”­ Future Features

- [ ] **Improve the UI of the application**
- [ ] **Deploy the project**

(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 start ⭐️.

(back to top)

## πŸ™ Acknowledgments

I would like to thank the Ruby and Rails community for making the documentation simple and easy to use.

(back to top)

## ❓ FAQ

- **How can I let you know about a bug?**

- You could add an issue on the issues tab.

- **How can I contribute**

- Kindly send a message to see how you could help us.

(back to top)

## πŸ“ License

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

(back to top)