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

https://github.com/hfg43/blog_app


https://github.com/hfg43/blog_app

gems mvc-architecture postgresql ruby

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        


Blog App

# ๐Ÿ“— Table of Contents

- [๐Ÿ“– About the Project](#about-project)
- [๐Ÿ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [๐Ÿ’ป Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [๐Ÿ‘ฅ Authors](#authors)
- [๐Ÿ”ญ Future Features](#future-features)
- [๐Ÿค Contributing](#contributing)
- [โญ๏ธ Show your support](#support)
- [๐Ÿ™ Acknowledgements](#acknowledgements)
- [๐Ÿ“ License](#license)

# ๐Ÿ“– Blog App.

**Blog App** is a website created using Ruby on Rails and Postgresql to practice OOP, Data Base Migration and apply best practices. It allows users to create post, comments and give likes.

## ๐Ÿ›  Built With

### Tech Stack

Ruby


Postgresql

### Key Features

- **Use Gitflow**
- **Set Up Postgres Database**
- **Create Data Models using ERD Diagrams**
- **Use models to insert data**
- **Use CRUD methods**
- **Add methods in models**
- **Include validations**
- **Add Unit test**
- **Add controllers**
- **Define Routes**
- **Include controllers actions**
- **Add test using Rspec gem for all controllers**
- **Add views following controller methods**
- **Give style following wireframes design**
- **Add forms to add new post and comments**
- **Add functionality to add likes**
- **Review Linters**

(back to top)

## ๐Ÿ’ป Getting Started

This repository includes files with ruby lenguage.

### Prerequisites

In order to run this project you need to have Ruby installed, check [this](https://www.ruby-lang.org/en/) documentation in order to know how to install it.

### Setup

Clone this repository to your desired folder:

cd my-folder https://github.com/HFG43/Blog_app
git clone

### Usage

To populate the database, in your command line execute:

```sh
rails db:seed
```

To run the project, in your command line execute the following:

```sh
rails s
```
To check the linters you can use the command:

```sh
rubocop
npx stylelint "**/*.{css,scss}"
```

To fix the linter use:

```sh
rubocop --fix
```

(back to top)

## ๐Ÿ‘ฅ Authors

๐Ÿ‘ค **Hernรกn Gรผemes**

- GitHub: [@githubhandle](https://github.com/HFG43)
- Twitter: [@twitterhandle](https://twitter.com/HFG_43)
- LinkedIn: [@Hernรกn Gรผemes](linkedin.com/in/hernanguemes)

๐Ÿ‘ค **Ahmed Eid**

- GitHub: [Ahmed Eid](https://github.com/ahmedeid6842)
- Twitter: [@ahmedeid2684](https://twitter.com/ahmedeid2684)
- LinkedIn: [Ahmed Eid](https://www.linkedin.com/in/ameid/)

(back to top)

## ๐Ÿ”ญ Future Features

- [ ] **Deploy**

(back to top)

## ๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## โญ๏ธ Show your support

If you like this project you could clone the repo and work with it or do the changes in a new branch. Also you could let a message with your thoughts.

(back to top)

## ๐Ÿ™ Acknowledgments

I would like to thank Microverse for providing the necessary resources for this project.

(back to top)

## ๐Ÿ“ License

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

(back to top)