Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/itsmraga-hub/elite-blog

The Elite Blog app is a classic example of a blog website. I created a fully functional website that will show users the list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/itsmraga-hub/elite-blog

rails rails-application ruby-on-rails

Last synced: 7 days ago
JSON representation

The Elite Blog app is a classic example of a blog website. I created a fully functional website that will show users the list of posts and empower readers to interact with them by adding comments and liking posts.

Awesome Lists containing this project

README

        

logo

Elite Blog

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 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)

# 📖 [Elite Blog]

> The Elite Blog app is a classic example of a blog website. I created a fully functional website that will show users the list of posts and empower readers to interact with them by adding comments and liking posts.

**[Elite Blog]** is a blog website.

## 🛠 Built With

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Client

Server | Backend

Database

### Key Features

> Describe between 1-3 key features of the application.

- **[key_feature_1]**
- Add blog posts to website.
- **[key_feature_2]**
- Interact with posts by liking and adding comments to posts by other people.
- **[key_feature_3]**
- User authentication. Set post to either public or private.

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Live Demo Link coming soon](https://yourdeployedapplicationlink.com)

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/itsmraga-hub/elite-blog.git
cd elite-blog
Open in your favorite editor
```

### Install

Install this project with:

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

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
bin/rails test test/models/article_test.rb
```

### Deployment

You can deploy this project using:

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **William Raga**

- GitHub: [@itsmraga-hub](https://github.com/itsmraga-hub)
- Twitter: [@RagaMacharia](https://twitter.com/RagaMacharia)
- LinkedIn: [William Raga](https://linkedin.com/in/itsmraga)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**

(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

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## 📝 License

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

(back to top)