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

https://github.com/faranoshamini/rails-blog


https://github.com/faranoshamini/rails-blog

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 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 (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Rails-blog]

**[Rails-blog]** The Rails-blog is a classic example of a blog website. It is 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

* Services (job queues, cache servers, search engines, etc.)

Client

* Deployment instructions

Server

* ...

Database

### Key Features

- **[Create post]**
- **[Comment on post]**
- **[Like posts]**

(back to top)

## 💻 Getting Started

### 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/FaranoshAmini/rails-blog.git
### Install

Install this project with:

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

### Deployment

You can deploy this project using:

(back to top)

## 👥 Author

👤 **Faranosh Amini**

- GitHub: [@githubhandle](https://github.com/FaranoshAmini)
- Twitter: [@twitterhandle](https://twitter.com/Faranosh_Amini)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/faranosh-amini-9b925b23a/)

(back to top)

## 🔭 Future Features

- [ Add Views ]
- [ Add Forms ]
- [ Integration specs for Views and fixing n+1 problems]

(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 my project please give the repo a star and share it with your friends

(back to top)

## 🙏 Acknowledgments
> I would like to thank Microverse for the project.

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)