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

https://github.com/inspecta/blog

Blog site. Register and login user. Logged in user can add a post. Users can comment on and like the post. Only owner can delete post.
https://github.com/inspecta/blog

cancancan capybara devise postgresql rswag-api rubocop ruby-on-rails

Last synced: 9 months ago
JSON representation

Blog site. Register and login user. Logged in user can add a post. Users can comment on and like the post. Only owner can delete post.

Awesome Lists containing this project

README

          


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

# 📖 BLOG

**BLOG ** is a classic example of a blog website. A user will be able to login into the application (Credentials: Username and Password). The logged in user can create posts. These posts will be listed and readers of these posts will be empowered to interact with the posts by either adding comments or even liking the posts.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **Log into the application**
- **Create a post for the application users**
- **Interact with the posts (Like post or comment on Post)**

(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:
- Ruby and rails installed
- PostgreSQL server installed also

### Setup

Clone this repository to your desired folder:

```sh
mkdir blog-app
cd blog-app
git clone git@github.com:inspecta/Blog.git
```

### Install

Install this project with:

```sh
cd Blog
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
```

(back to top)

## 👥 Authors

👤 **Author1**

- GitHub: [@inspecta](https://github.com/inspecta)
- Twitter: [@djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [mulinde-derrick](https://linkedin.com/in/mulinde-derrick)

👤 **Author2**

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

(back to top)

## 🔭 Future Features

- [ ] **A better graphical user interface**
- [ ] **A signup functionality**
- [ ] **A chat functionality**

(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, go ahead and give it a star. It is very much appreciated.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for providing me with the reading material that helped me during this project development.

(back to top)

## ❓ FAQ (OPTIONAL)

- **Can I reuse this projects' code?**

- Yes, it is okay.

- **Can I contribute to this repository?**

- Yes. Just contact me at `djmulinde@gmail.com` and I will gladly add you as a contributor to the repository.

(back to top)

## 📝 License

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