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

https://github.com/alierpm/blog

This blog is a functional website that show the list of posts and empower readers to interact with them by: adding comments and liking posts.
https://github.com/alierpm/blog

postgresql rspec-testing ruby ruby-on-rails

Last synced: 2 months ago
JSON representation

This blog is a functional website that show the list of posts and empower readers to interact with them by: adding comments and liking posts.

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)
- [🚀 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)

# 📖 Blog

> This blog is a functional website that show the list of posts and empower readers to interact with them by:

- [x] adding comments

- [x] liking posts.

## 🛠 Built With

### Tech Stack

> This Project was Build with the following:

Client

Unit Testing

## 🚀 Live Demo

> Add a link to your deployed project.

- [Coming soon....](https://yourdeployedapplicationlink.com)

(back to top)

## 💻 Getting Started

> The following steps were used in creating this project:

1 Setup the project by creating a new directory from the generated repository.

2 Set up the repository on GitHub and use Gitflow.

3 Initialized project with rubocop linters

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

### Prerequisites

In order to run this project you need:

1 Ruby installed (Using Homebrew on macOS machine)

```sh
brew install ruby
```

2 Rails Installed

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/AlierPM/blog.git
```

### Install

Install this project with:

```sh
cd blog
```

### Usage

To run the project, execute the following command:

```sh
cd blog
```
```sh
code .
```

### Run project

To run from the local server, run the following command:

```sh
rails server
```
### Run tests

To run tests, run the following command:

```sh
rpec spec
```

(back to top)

## Authors

👤 **Alier Philip Maguet**

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

(back to top)

## 🔭 Future Features

> Features that will be added to the project.

- [x] **Add user login UI**
- [x] **Add sign up page**
- [x] **Add sharing of posts option**

(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

> Your contructive reviews help us to improve progressively

If you like this project...

(back to top)

## 🙏 Acknowledgments

>[Microverse](https://www.microverse.org/?grsf=0gzf37)

I would like to thank the Microverse for offering this topic notch course that has equiped me to be a full stack Ruby on Rails Developer

(back to top)

## ❓ FAQ

> You want to know! Relax! We got you!

- **How Long did it take to build this project?**

- [x] 5 days

- **How many git conflicts did you resolve?**

- [x] More than five (5) conflicts resolved

(back to top)

## 📝 License

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

(back to top)