Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/maximoortelli/blog_app


https://github.com/maximoortelli/blog_app

Last synced: 20 days ago
JSON representation

Awesome Lists containing this project

README

        

# Blog_App

## 📗 Table of Contents

- [Blog\_App](#blog_app)
- [📗 Table of Contents](#-table-of-contents)
- [📖 Blog\_App ](#-blog_app-)
- [🛠 Tech-stack ](#-tech-stack-)
- [🛠 Built With ](#-built-with-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Setup ](#setup-)
- [Prerequisites ](#prerequisites-)
- [Usage ](#usage-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features](#future-features)
- [❓ FAQ ](#-faq-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show Your Support ](#️-show-your-support-)
- [🙏 Acknowledgements](#acknowledgements)
- [📜 License ](#-license-)

## 📖 Blog_App

The Blog app is a classic blog website. This application, is a fully functional website that displays a list of posts and allows readers to interact with them by adding comments and liking posts.

## 🛠 Built With

This project is built using Ruby on Rails, a dynamic, open-source programming language known for its simplicity and productivity. Ruby's elegant syntax and powerful features make it a popular choice among developers.

### Tech Stack

## Key Features
- [x] **Rails new (setup)**
- [x] **Data Model**

## 💻 Getting Started

To get started with the Catalog of My Things app, follow the instructions below:

### Setup

1. Clone the project repository:
bash
`git clone https://github.com/maximoortelli/Blog_App.git`

2. Navigate to the project folder:
bash
`cd Blog_App`

### Prerequisites

To run the Catalog of My Things app, you'll need the following prerequisites:

- An integrated development environment (IDE) like Visual Studio Code.
- Ruby installed on your machine.
- Git installed on your machine.
- A GitHub account for version control.

## Usage

Follow these steps to use the program:

1. Open your terminal.
2. Navigate to the directory where the program files are located using the `cd` command:

bash
`cd /path/to/your/program/files`

3. Start your Ruby on Rails server

bash
`rails s`

4. cess the Blog app in your web browser at `http://localhost:3000`.

5. You can now interact with the app, create posts, add comments, and explore its features.

### Run tests

To execute the tests, run the following command inside the project folder:

```bash
rspec
```

(back to top)

## 👥 Authors

This project was developed by:

👤 **Maximo Ortelli**
- GitHub: [@Maximo Ortelli](https://github.com/maximoortelli)
- LinkedIn: [@Maximo Ortelli](https://www.linkedin.com/in/maximo-ortelli-rueda/)

## 🔭 Future Features

- [x] Creating a data model.
- [x] Processing data in models.
- [x] Validations and Model specs.
- [x] Controllers.
- [x] Controllers specs.
- [x] Views.
- [x] Forms.
- [x] Integration specs for Views and fixing n+1 problems.
- [x] Add Devise.
- [x] Add authorization rules.
- [x] Add API endpoints.
- [x] API documentation.

(back to top)

## ❓ FAQ

*Q: Is there a plan to add more features to this application?*
A: Yes, the author has plans to enhance this application's capabilities. One upcoming feature is to make the application executable via tactil, providing more convenience and accessibility to users.

*Q: Where can I find more information about the Ruby programming language?*
A: For more information about Ruby, its features, and its community, visit the official [Ruby website](https://www.ruby-lang.org/).

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/maximoortelli/Blog_App/issues) and contribute to the project.

## ⭐️ Show Your Support

If you find this project helpful, consider giving it a ⭐️ to show your support!

## 📝 License

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

(back to top)