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

https://github.com/tsheporamantso/blogapp

The Blog app will be a classic example of a blog website. I've created a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/tsheporamantso/blogapp

cancancan devise factory-bot postgresql rspec-rails ruby-on-rails

Last synced: 7 months ago
JSON representation

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

Awesome Lists containing this project

README

          

BlogApp ⚡

# 📗 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Blog App

**Blog App** The Blog app is a classic example of a blog website. this 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

Server


### Key Features

- **Ruby on Rails**
- **Creating data model**
- **Functional website**
- **Database**
- **Unit Testing**

(back to top)

## 🚀 Live Demo

- Not live yet

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- Install ruby using [link](https://www.ruby-lang.org/en/documentation/installation/#apt)
- Install ruby on rails using [link](https://guides.rubyonrails.org/)

### Setup

Clone this repository to your desired folder:

```sh
mkdir folder_name
cd folder_name
git clone git@github.com:tsheporamantso/blogapp.git
```

### Install

Install this project with:

```sh
gem factory_bot_rails
```

```sh
gem rspec-rails
```

```sh
bundle install
```

```sh
rails generate rspec:install
```

```sh
rails db:migrate
```

### Usage

To run the project, execute the following command:
run the result on the terminal through:

```sh
rails server
```

### Run tests

To run tests, execute the following command on the terminal

```sh
bundle exec rspec
```

### Deployment

Not deployed

(back to top)

## 👥 Authors

👤 **Gladwin Tshepo Ramantso**

- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)

👤 **May Pyone**

- GitHub: [@May Pyone](https://github.com/MayPyone/)
- LinkedIn: [May Pyone](https://www.linkedin.com/in/may-pyone-9439961a3/)

(back to top)

## 🔭 Future Features

- [ ] **Validation and Model specs**
- [ ] **Processing data in models**
- [ ] **Controllers**
- [ ] **Controllers specs**
- [ ] **Views**
- [ ] **Forms**
- [ ] **Intergration specs for Views and fixing n+1 problems**
- [ ] **Add Devices**
- [ ] **Add authorizations rules**
- [ ] **Add API endpoints**
- [ ] **API documentation**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/tsheporamantso/blogapp/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give a star on [github](https://github.com/tsheporamantso/OOP-School-Library) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).

(back to top)

## 🙏 Acknowledgments

I would like to thank:

- [ ] **Microverse and all the staff**
- [ ] **Microverse Communinity**
- [ ] **Thanks to my coding Partners**
- [ ] **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- [ ] **Thanks to Code Reviewers**

(back to top)

## 📝 License

This project is [MIT](https://github.com/tsheporamantso/blogapp/blob/d839f9eb65e3377ebc269ceb1868bb8a7e7dfef1/LICENSE) licensed.

(back to top)