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

https://github.com/alibaba2023/blog_app

BlogApp An innovative web application built on Ruby on Rails, designed to empower you in establishing and maintaining a dynamic blog platform. 🛠 Built With
https://github.com/alibaba2023/blog_app

rails ruby

Last synced: 2 months ago
JSON representation

BlogApp An innovative web application built on Ruby on Rails, designed to empower you in establishing and maintaining a dynamic blog platform. 🛠 Built With

Awesome Lists containing this project

README

          

## 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [Future Features](#future-project)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show Your Support](#support)
- [📜 License](#license)

## 📖 About the Project

**BlogApp** An innovative web application built on Ruby on Rails, designed to empower you in establishing and maintaining a dynamic blog platform.

## 🛠 Built With

Constructed with Ruby on Rails, an influential web framework celebrated for its user-friendly and efficient nature.

## Key Features

- ✅ Interactive commentary system for engaging with articles.
- ✅ Favoriting and unfavoriting articles.
- ✅ Adaptable web design for various devices.
- ✅ Reliable error management and data validation.

## 🔭 Future Features
- [ ] Advanced text editor for styling articles. ✅
- [ ] Sharing articles on social media platforms. ✅
- [ ] API connections to facilitate external integrations. ✅

## 💻 Getting Started

To get started with the Blog App, follow the instructions below:

### Prerequisites
**Before you can run the Blog App, make sure you have the following prerequisites:**

- ✅ **Ruby**: Ensure that Ruby is installed on your machine. 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 you don't have it yet, you can install it using the following command:
```
gem install rails
```
- ✅ **PostgreSQL**: 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/).

1. To install ruby on windows using WSL:
```
- Install WSL, So Open powershell as admin and run: wsl --install
- Restart the computer , it will continue ubuntu installation
- Add user name and password
```

2. After WSL installion:
```
- Open Ubuntu terminal and run following commands:
- (Optional) Update Ubuntu:
sudo apt update
sudo apt upgrade
- Install Ruby:
sudo apt install ruby
- Verify installation:
ruby --version
- Install package manager:
sudo gem install bundler
```

### 🛠 Setup

1. ✔ Clone the project repository:

```bash
git clone git@github.com:Alibaba2023/blog_app.git
```
2. ✔ Navigate to the project folder:

```bash
cd blog_app
```

### 📖 Usage

To get a local copy up and running, follow these steps.
Choose the directory on your local machine where you want to copy the project. For example:

```
cd /home/user/name-of-your-directory
```

Start the Rails server:

Copy code
```bash
rails server
```
Open your web browser and go to http://localhost:3000 to access the Blog App.

## 👥 Authors

👤 **Ali Baba Hussaini**

- GitHub: [@Alibaba2023](https://github.com/Alibaba2023/)
- LinkedIn [Alibaba Hussaini](https://www.linkedin.com/in/ali-baba-hussaini-630607267/)

👤 **Hajnalka Oltyan**

- GitHub: [@hajnaloltyan](https://github.com/hajnaloltyan)
- LinkedIn: [Hajnal Oltyan](https://www.linkedin.com/in/hajnalka-oltyan/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the issues [page](https://github.com/Alibaba2023/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!

## Acknowledgments

We would like to express our gratitude to the Ruby community and Microverse for the readme template.

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