Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/luffytaro22/blog-app

Blog App is an application that allows different users to log in, make posts, and comment and like other posts.
https://github.com/luffytaro22/blog-app

postgresql rails ruby ruby-on-rails

Last synced: 12 days ago
JSON representation

Blog App is an application that allows different users to log in, make posts, and comment and like other posts.

Host: GitHub
URL: https://github.com/luffytaro22/blog-app
Owner: Luffytaro22
License: mit
Created: 2023-09-19T16:41:40.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2024-01-09T16:14:44.000Z (about 1 year ago)
Last Synced: 2024-12-26T07:24:13.886Z (16 days ago)
Topics: postgresql, rails, ruby, ruby-on-rails
Language: Ruby
Homepage: https://blog-app-efud.onrender.com/
Size: 262 KB
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

📗 Table of Contents

📖 About the Project

🚀 Live Demo

💻 Getting Started
- Setup
- Prerequisites
- Install
- Usage
- Run tests
- Deployment

👥 Authors

🔭 Future Features

🤝 Contributing

⭐️ Show your support

🙏 Acknowledgements

📝 License

# 📖 Blog App

**Blog App** is an application that allows different users to log in, make posts, and comment and like other posts.

The information is saved in a PostgreSQL database with these tables:
![image](./app/assets/images/blog_app_erd_v1_1.png)

## 🛠 Built With

### Tech Stack

Back-end

Ruby on Rails

PostgreSQL

Front-end

HTML5

ERB template

### Key Features
* Use of Rails framework.
* MVC architecture.
* Save and retrieve information from a PostgreSQL database.
* Devise gem.
* Capybara tests with RSpec.
* CanCanCan gem.
* Rswag gem and API documentation.
* RESTful API.

(back to top)

### 🚀 Live Demo
[Live Demo](https://blog-app-efud.onrender.com/)

(back to top)

## 💻 Getting Started

### Prerequisites
In order to run this project you need to have:

- Installed Ruby and Rails.
- If you're using Windows, have installed WSL.
- If you're using MacOS, an option is using UTM.

### Setup
To clone this repository to your desired folder, run the following command:

```
git clone [email protected]:Luffytaro22/Blog-App.git
```

(back to top)

### Usage
To open a local server, type the following command:
```
rails server
```
To ses the API's documentation, open the local server and go to:
```
/api-docs
```

(back to top)

### Install
To install all the ruby gems, use the following command:
```
bundle install
```
After installing the gems, run this commando to create and migrate a database:
```
rails db:create db:migrate
```

(back to top)

### Run tests
To run the RSpec unit tests, use the following command:
```
rspec
```

(back to top)

## 👥 Authors

👤 **Manuel Sánchez**

- GitHub: [@Luffytaro22](https://github.com/Luffytaro22)
- LinkedIn: [Manuel Sánchez](https://www.linkedin.com/in/manuel-alejandro-sanchez-sierra/)

👤 **lRebornsl**

- GitHub: [@lRebornsl](https://github.com/lRebornsl)
- Twitter: [@RebornsDev](https://twitter.com/RebornsDev)
- LinkedIn: [Anthony Vásquez](https://www.linkedin.com/in/avvm98/)

(back to top)

## 🔭 Future Features
- [ ] **Integrate a Front-end framework.**
- [ ] **Improve UX and UI.**
- [ ] **Let the users follow each other.**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support
If you like this project please give it a star ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to give credits to the following:
* **Microverse** for this readme template.

(back to top)

## 📝 License

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

(back to top)