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

https://github.com/jfoyarzo/rails-blog


https://github.com/jfoyarzo/rails-blog

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Rails Blog ](#-rails-blog-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 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 ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Rails Blog

**Rails blog** is a blog app written using Ruby on Rails and the MVC design pattern. It's currently on its early stages, and it's part of the Microverse curriculum.

## 🛠 Built With

### Tech Stack

Client / Backend

Database

### Key Features

- **Add users**
- **Each user can create many posts**
- **Each post can have many likes and comments**

(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:
- Ruby version 2.7.0 or later
- Rails version 6 or later

### Setup

Clone this repository to your desired folder:

`https://github.com/jfoyarzo/rails-blog.git`

`cd rails-blog`

### Install

Install dependencies for this project using:

`bundle install`

>For local PostgreSQL database integration, remember to provide the correct credentials using `rails credentials:edit`

### Usage

To start the server, execute the following command:

`rails server`

### Run tests

To run tests, run the following command:

`rspec`

### Deployment

Coming soon...

(back to top)

## 👥 Authors

👤 **Felipe Oyarzo**

- GitHub: [@jfoyarzo](https://github.com/jfoyarzo)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/jorge-felipe-oyarzo-contreras)

(back to top)

## 🔭 Future Features

- [ ] **Controllers**
- [ ] **Views**
- [ ] **Frontend UI**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/jfoyarzo/rails-blog/issues/).

(back to top)

## ⭐️ Show your support

If you like this project please consider giving it a star!

(back to top)

## 🙏 Acknowledgments

We would like to thank [Microverse](https://www.microverse.org/) for the opportunity.

(back to top)

## 📝 License

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

(back to top)