Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/graujavier/blog-app-ruby


https://github.com/graujavier/blog-app-ruby

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Ruby on Rails Blog App



## 📗 Table of Contents



- [📖 Project Overview](#about-project)

  - [🛠 Technology Stack](#built-with)

  - [Key Features](#key-features)

  - [Upcoming Features](#future-project)

- [💻 Getting Started](#getting-started)

  - [Setup Instructions](#setup)

  - [System Requirements](#prerequisites)

  - [How to Use](#usage)

- [👥 Author](#authors)

- [🤝 Contribution](#contributing)

- [⭐️ Support](#support)

- [📜 License](#license)



## 📖 Project Overview 



Welcome to the Blog App, a Ruby on Rails-based application designed for creating and managing a fully functional blog website. This project empowers users to publish articles, engage with posts through comments and likes, and more.



## 🛠 Technology Stack 



This project is developed using Ruby on Rails, a robust web framework renowned for its simplicity and productivity. Ruby on Rails serves as an excellent foundation for swiftly and efficiently building web applications.



##  Key Features 



- [ ] Full-fledged Ruby on Rails application.

- [ ] User authentication and authorization.

- [ ] Article creation, editing, and deletion.

- [ ] Comment system for interacting with articles.

- [ ] Liking and unliking articles.

- [ ] Responsive web design.

- [ ] Strong error handling and validation.



Please note: Each feature will be marked with an "x" when it is fully implemented and operational.



## 🔭 Upcoming Features 



- [ ] Search functionality for locating specific articles.

- [ ] User profiles with customizable avatars.

- [ ] Article categories and tagging.

- [ ] Rich text editor for formatting articles.

- [ ] Social media sharing options for articles.

- [ ] API endpoints for external integrations.



## 💻 Getting Started 



To begin using the Blog App, please follow the instructions below:



### 🛠 Setup Instructions 



1. Clone the project repository:



   ```bash

   git clone https://github.com/grauJavier/blog-app-ruby.git

    ```



2. Navigate to the project folder:



    ```bash

    cd blog-app-ruby

    ```



### System Requirements 

Before you can run the Blog App, ensure the following prerequisites and configurations are in place:



- **Ruby**: Confirm that Ruby is installed on your machine. You can check for its presence by running `ruby -v` in your terminal. If it's not installed, you can download and install it from the [official Ruby website](https://www.ruby-lang.org/en/documentation/installation/).



- **Ruby on Rails**: You'll need the Ruby on Rails framework installed. If it's not already installed, you can do so with the following command:

  ```

  gem install rails

  ```



- **Code Editor**: You should have a code editor like Visual Studio Code (VSCode) installed. You can download VSCode from the [official website](https://code.visualstudio.com/).



- **Git**: Git is essential for version control. Ensure you have Git installed and properly configured on your system. You can download Git from the [official Git website](https://git-scm.com/downloads).



- **PostgreSQL**: Verify that PostgreSQL is installed and correctly configured on the server where you plan to develop the project. This project assumes the use of PostgreSQL as the default database. You can download PostgreSQL from the [official PostgreSQL website](https://www.postgresql.org/download/).



- **Ruby on Rails Configuration**: Ensure that your Ruby on Rails project is configured to use PostgreSQL as the default database.



Once you've set up these prerequisites and configurations, you'll be ready to set up and run the Blog App.



### How to Use 

Follow these steps to utilize the Blog App:



1. Open your terminal.



2. Navigate to the directory where the project files are located:



   ```bash

   cd /path/to/your/project/files

   ```



3. Start the Rails server:



   ```bash

   rails server

   ```



4. Open your web browser and visit http://localhost:3000 to access the Blog App.



## 👥 Author 

👤 **Javier Grau**

- GitHub: [grauJavier](https://github.com/grauJavier)

- LinkedIn: [@javiergrau](https://www.linkedin.com/in/javiergrau/)

- Twitter: [@jgrauchile](https://twitter.com/jgrauchile)



👤 **Andrea Manuel**

- GitHub: [@AndreaM2429](https://github.com/AndreaM2429)

- LinkedIn: [Andrea Manuel](https://www.linkedin.com/in/andreamanuel24/)

- Twitter: [@AndreaManuelOr1](https://twitter.com/AndreaManuelOr1)



## 🤝 Contribution 



Contributions, issues, and feature requests are highly encouraged! 

Feel free to explore the issues [page](https://github.com/grauJavier/blog-app-ruby/issues) and contribute to the project.



## ⭐️ Support 

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



## 📜 License 

This project is licensed under the [MIT License](https://github.com/grauJavier/blog-app-ruby/blob/dev/MIT.md).