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

https://github.com/blase147/firmtecs_blog

This app is a classic example of a blog website. It is a fully functional website that shows list of posts and encourage readers to interact with them by adding comments and liking posts.
https://github.com/blase147/firmtecs_blog

postgres rails ruby

Last synced: 2 months ago
JSON representation

This app is a classic example of a blog website. It is a fully functional website that shows list of posts and encourage readers to interact with them by adding comments and liking posts.

Awesome Lists containing this project

README

          

![](https://img.shields.io/badge/Microverse-blueviolet)

# 📗 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](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Firmtecs_blog

This Firmtecs_blog app is a classic example of a blog website. I'm created a fully functional website that shows list of posts and encourage readers to interact with them by adding comments and liking posts.

## 🛠 Built With

### Tech Stack

Client

Server

Database

## Key Features

- **Use RubyGems as a software package system.**
- **Use database migration files to maintain database schema**
- **Understand ORM**

(back to top)

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

- IDE or code editor: **VsCode, atom, sublime**...
- To have [Ruby](https://www.ruby-lang.org/en/), [RoR gem](https://rubyonrails.org/) and [Git](https://git-scm.com/) installed on your system.

### Setup

Clone this project on your local machine using the following command on your terminal:

```sh
git clone https://github.com/blas147/Firmtecs_blog.git
```

### Install

Run the following command to install all project's dependencies:

```sh
bundle install
```

Run the following command to install Rspec for tests:

```sh
gem install rspec
```

### Usage

To run the project, execute the following command:

```sh
rails s
```

## Run Tests

Run the following command to catch all style errors:

```sh
rubocop
```

Run the following command for the rspec tests(with details):

```sh
rspec ./spec --format documentation

```

## 👥 Author

👤 **Chukwuma Paul Mosanya**

[GitHub](https://github.com/blase147) | [Twitter](https://twitter.com/ChukwumaMosanya) | [LinkedIn](https://www.linkedin.com/in/chukwuma-mosanya)

(back to top)

## 🔭 Future Features

- Views.
- Forms
- Validations, Model specs, and n+1 problems.
- Add Devise.
- Add authorization rules.
- Integration specs for Views.
- 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/blase147/firmtecs_blog/issues/new).

(back to top)

## ⭐️ Show your support

> Give this project a star if you like it...

(back to top)

## 📝 License

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

(back to top)