Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarMWarraich committed Aug 6, 2024
1 parent d81396f commit 495f366
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@

## Project Description

This project is a blog application that allows users to create, edit, and delete posts and upload images. The application is built using Ruby on Rails and React. The frontend is built using React and the backend is built using Ruby on Rails. The application also uses PostgreSQL as the database.
The frontend is built using React and the backend is built using Ruby on Rails while PostgreSQL is used as the database. The application allows users to create an account and log in. Users can create, edit, and delete posts. Users can also upload images to their posts. The application also has a search functionality that allows users to search for posts by title. The application also has pagination that allows users to navigate through the posts. The backend is hosted on an EC2 instance using docker-compose while the frontend is hosted through AWS-Amplify while using Route 53 for DNS.

[Frontend](https://github.com/omarMWarraich/ror-react-app-frontend)

## 🛠 Built With <a name="built-with"></a>

Expand Down Expand Up @@ -63,14 +65,15 @@ This project is a blog application that allows users to create, edit, and delete
- **Pagination**
- **Search Functionality**
- **Responsive Design**
- **User Authentication**

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LIVE DEMO -->

## 🚀 Live Demo <a name="live-demo"></a>

- Coming Soon.
[Live Demo](https://ror-react-blog.topgeardirect.com/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -139,9 +142,9 @@ rspec spec

## 🔭 Future Features

- Add User Authentication
- Add User Authorization
- Add User Roles
- Add Notifications

## 🤝 Contributing

Expand All @@ -165,4 +168,4 @@ I would like to thank Deanin for his guidance and support throughout the project

## 📝 License

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

0 comments on commit 495f366

Please sign in to comment.