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

https://github.com/luigirazum/ror-blog

RoR Blog is a Blog App oriented for Rails Developers where they will be able to learn or teach from other's experiencies. It's a fully functional website that will show the Posts made by the Developers and empower other Developers to interact with them by Adding Comments to the Post or showing their support by giving a Like to theirs Post.
https://github.com/luigirazum/ror-blog

Last synced: about 2 months ago
JSON representation

RoR Blog is a Blog App oriented for Rails Developers where they will be able to learn or teach from other's experiencies. It's a fully functional website that will show the Posts made by the Developers and empower other Developers to interact with them by Adding Comments to the Post or showing their support by giving a Like to theirs Post.

Awesome Lists containing this project

README

          

logo

### RoR-Blog
**RoR-Blog** is a _Blog App_ oriented for Rails Developers where they will be able to learn or teach from other's experiencies. It's a fully functional _website_ that will show the _Posts_ made by the Developers and empower other Developers to interact with them by _Adding Comments_ to the _Post_ or _showing their support by giving_ a _Like_ to theirs _Post_.


# πŸ“— Table of Contents

- [πŸ’¬ About the project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸ’» Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run](#run)
- [Open](#open)
- [πŸ‘₯ Author](#author)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [πŸ“ License](#license)


# πŸ’¬ **RoR-Blog**

**RoR-Blog** is a _Blog App_ oriented for Rails Developers where they will be able to learn or teach from other's experiencies. It's a fully functional _website_ created with [Rails](https://rubyonrails.org/) that will show the _Posts_ made by the Developers and empower other Developers to interact with them by _Adding Comments_ to the _Post_ or _showing their support by giving_ a _Like_ to theirs _Post_.

- ### Building the **RoR-Blog** App

The end result should follow the next **ERD** data model:


Data model

> To _preserve_ the data we are going to create a [PostgreSQL](https://www.postgresql.org/) **Database** based on the **ERD Diagram** showed below.

This project keep the following wireframes:


Login page wireframe
All users page wireframe
Single user page wireframe


All posts by a given user page wireframe
Single post page wireframe

This project is made mostly to practice our knowledge and learn more about [**Ruby on Rails**](https://rubyonrails.org/) concepts - starting from the _**Views**_ and finishing the _**database connection**_.

We will also **implement** ideas like _**authentication**_, _**authorization**_, and all kinds of _**tests**_.

Last but not least, we will have a chance to **create** an _**API**_ instead of _API consumption_, so the project could be implemented on mobile platforms as well.

## πŸ›  Built With

- ### Tech Stack

- ### Key Features

**RoR-Blog** users will be able to:
- **Create** _Posts_.
- Leave a _Comment_ (**create**) to any _Post_.
- Give their support to a _Post_ by liking(**create**) it.

(back to top)

## πŸ’» Getting Started

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

- ### Prerequisites

- `git` installed. Please got to [Getting Started - Installing Git guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and follow the steps described for your system to install `git`.
- `Ruby` installed, you can go to the [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/) documentation and follow the steps for your computer OS.
- `Rails` installed, you can follow the [GoRails Tutorial](https://gorails.com/setup/) and follow the steps for your computer OS.
- `PostgreSQL` installed, you can follow the [PostgreSQL Tutorial](https://www.postgresqltutorial.com/) and follow the steps for your computer OS.

- ### Setup
Clone this repository to your `local-folder`:
```sh
cd local-folder
git clone git@github.com:luigirazum/ror-blog.git
```
- ### Usage
In the `local-folder` where you cloned the project, go into the project folder
```sh
cd ror-blog
```
- ### Prepare
In the `ror-blog` folder, use the following code to install the app dependencies
```rb
bundle install
```
- ### Run
In the `ror-blog` folder, use the following code to run the app
```rb
rails server
```
- ### Open
Open your favorite `browser` and type in the address bar
```sh
http://localhost:3000
```

(back to top)

## πŸ‘₯ Author

πŸ‘¨β€πŸ’» **Luis Zubia**

(back to top)

## πŸ”­ Future Features

- **Delete** a _Post_ previously created.
- **Delete** a _Comment_ previously created.
- **Unlike** a certain _Post_.
- Implement **Authentication** options like _Registration_(**sign-up**), _LogIn_(**log-in**), _LogOut_(**log-out**), _Change Password_ for `Users`
- Implement **Authorization**, so _Post_'s, _Comment_'s and _Like_'s that weren't created by the logged user can be modified or deleted only by the user who created it.

(back to top)

## 🀝 Contributing

Contributions, issues, typos, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, your support giving a ⭐ will be highly appreciated.

(back to top)

## πŸ™ Acknowledgments

- I would like to thank [Yukihiro β€œMatz” Matsumoto](http://www.rubyist.net/~matz/) for creating the [Ruby Programming Language](https://www.ruby-lang.org/en/).
- Thanks [David Heinemeier Hansson](https://en.wikipedia.org/wiki/David_Heinemeier_Hansson) for sharing [Rails](https://rubyonrails.org/) to the world.\
_**Wikipedia:** [Ruby on Rails - History](https://en.wikipedia.org/wiki/Ruby_on_Rails)_

(back to top)

## πŸ“ License

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

(back to top)