Microverse README Template

📗 Table of Contents

📖 About the Project
- 🛠 Built With
  - Tech Stack
  - Key Features
💻 Getting Started
- Setup
- Prerequisites
- Install
- Usage
- Run tests
- Deployment
👥 Authors
🔭 Future Features
🤝 Contributing
⭐️ Show your support
🙏 Acknowledgements
📝 License

📖 Blog-App

Blog-App is an app that allows users to create blog posts and perform actions such as liking and commenting on these blog posts.

🛠 Built With

Tech Stack

Server

Ruby

Database

PostgreSQL

Key Features

Create a comment
Create a post
Create a like
Create a user

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

To install ruby on your PC. You can read this documentation on how to do so
To install sqlite3 on your PC. You can read this documentation on how to do so
Know how to navigate directories or folders at the CLI.
Know how to get the URL(https/ssh) of a repository on GitHub.
You should have a code editor installed, preferably VSCode.
In order to run this project you need:

Setup

Clone this repository to your desired folder:

  git clone git@github.com:SabiMantock/blog-app.git

Install

Install this project with:

  cd blog-app
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

 rspec spec

Deployment

You can deploy this project using:

 Render
 Heroku

(back to top)

👥 Authors

👤 Sabi Mantock

GitHub: @SabiMantock
Twitter: @IamSabiMantock
LinkedIn: Sabi Mantock

(back to top)

🔭 Future Features

integration specs for views and fix n+1 problems

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give me ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)