https://github.com/ridwanullahi-code/blogapp

Last synced: about 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/ridwanullahi-code/blogapp
Owner: Ridwanullahi-code
License: mit
Created: 2023-04-05T11:53:05.000Z (about 3 years ago)
Default Branch: development
Last Pushed: 2023-06-24T21:26:12.000Z (almost 3 years ago)
Last Synced: 2025-01-30T06:29:29.566Z (over 1 year ago)
Language: Ruby
Size: 773 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Book App

**Book App** is a Ruby on Rails web-based platform that allows book lovers to discover new books, post, and comment on book. The application offers a variety of features to help users find and review books, as well as socialize with other readers.

## 🛠 Built With

### Tech Stack

Server

Ruby

Database

PostgreSQL

### Key Features

- User Profile: Users have a personal profile page where they can view their reviews, edit their account details, and see their activity on the application.

- Book Search: Users can search for books by title or author. The application integrates with the Google Books API to fetch data about books, including their cover image, title, author, and description.

- Book Details: Users can view the details of a book, including its cover image, title, author, and description. They can also see other users' reviews for the book.

(back to top)

## 💻 Getting Started

### Prerequisites
📘 📗 📕 📙

Before installing this application, you need to have the following software installed on your machine:

- Ruby 2.6.3 or higher
- Rails 6.0.0 or higher
- PostgreSQL

### Install

To install this application, follow these steps:

1. Clone this repository to your local machine using the command

```sh
git clone git@github.com:Ridwanullahi-code/BlogApp.git

```
OR

```sh
git clone git https://github.com/Ridwanullahi-code/BlogApp.git

```
2. Navigate to the root directory of the application using the command

```sh
cd BookApp
```
3. Install the required gems by running the command

```sh
bundle install
```
4. Create the database by running the command

```sh
rails db:create
```

5. Migrate the database by running the command

```sh
rails db:migrate
```

### Usage

To use this application, follow these steps:

1. Start the server by running the command
```sh
rails server
```
2. Open your web browser and navigate to
```sh
http://localhost:3000
```

### Run tests

To run tests, run the following command:

Example command:

```sh
rspec spec
```

(back to top)

## 👥 Authors

## **Author1**

- Github: [Ridwan](https://github.com/Ridwanullahi-code)
- LinkedIn: [Ridwan](https://www.linkedin.com/in/ajayi-ridwan/)

## 🚀 **About Me**

I'm full stack software developer, Computer science, and Microverse student.

**Stack:** Python, JavaScript, Bootstrap, Ruby, Rails, React, Redux. Available for hire!

(back to top)

## 🔭 Future Features

- Book Recommendations: The application can use machine learning algorithms to provide personalized book recommendations based on users' reading history and reviews.

- Book Clubs: Users can create and join book clubs, where they can discuss books with like-minded individuals and participate in virtual meetings.

- Audio Books: The application can integrate with audio book providers such as Audible to offer users the option to listen to books in addition to reading them.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Ridwanullahi-code/BlogApp/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

-I would like to thank [Microverse](https://www.microverse.org/) for providing good material and well-detailed project requirements

(back to top)

## ❓ FAQ (OPTIONAL)