Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/omarmwarraich/theblog

A blog for users to upload their posts, and to make comments on different posts besides liking different comments or posts.
https://github.com/omarmwarraich/theblog

rubocop-configuration ruby-gems rubyonrails stylelint-config

Last synced: about 6 hours ago
JSON representation

A blog for users to upload their posts, and to make comments on different posts besides liking different comments or posts.

Awesome Lists containing this project

README

        

logo

Microverse README Template

# 📗 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)

# 📖 [TheBlog]

**[TheBlog]** is a blog where you can share your thoughts and opinions with the world. You can create an account, log in, create posts, and comment on other posts.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

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

- **[key_feature_1]** Coming Soon
- **[key_feature_2]** Coming Soon
- **[key_feature_3]** Coming Soon

(back to top)

## 🚀 Live Demo

- [Coming Soon]

(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 [email protected]:myaccount/my-project.git
```

### 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/comment_test.rb
bin/rails test test/models/post_test.rb
bin/rails test test/models/user_test.rb
bin/rails test test/models/like_test.rb
```

### Deployment

You can deploy this project using:

```sh
Coming Soon
```

(back to top)

## 👥 Authors

👤 **OmarMWarraich**

- GitHub: [@OmarMWarraich](https://github.com/OmarMWarraich)
- Twitter: [@omarwarraich1](https://twitter.com/omarwarraich1)
- LinkedIn: [o-va](https://linkedin.com/in/o-va)

(back to top)

## 🔭 Future Features

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

- [ ] **[new_feature_1]** Coming Soon
- [ ] **[new_feature_2]** Coming Soon
- [ ] **[new_feature_3]** Coming Soon

(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 Microverse for giving me the opportunity to learn and grow as a developer.

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