Bookwise

Bookwise is a website to share your rating about a book that you read. Besides, you can search for books based on their category, see your profile statistics, last ratings, popular books, and other features.

In this project, I learned and practiced a lot of NextJS features, like SSR and SSG. Furthermore, other technologies and libraries were used, like NextAuth for authentication using OAuth 2.0, Prisma ORM, MySQL Database, React Query, Axios, ZOD, React Hook Form and others.

Bookwise | Status: Done ✔️

Table of Contents

• Features
• Requirements to run the project
• Running the application
• Main Technologies
• Final Result
  • Login page
  • Home page
  • Explore page
  • Profile page
  • Book modal
• Deploy
• License
• Author
• Contributing Guidelines

Features

Bookwise allows you to expose your opinion about a certain book, sharing it with other people who register on the platform. Besides, the books are organized based on each category you choose. Also, you sign in on the website by using OAuth 2.0 provided by Google or by Github.

1. Browse the latest book reviews and the popular books

The Home page shows the latest book reviews sent by users registered on the platform, as well as the most popular books.

2. Explore all books based on each category

The Explore page shows all books based on each category available in the database. By clicking on a certain book, its detailed information appears. Additionally, you can write down a rating for the book selected and send it.

3. View your profile data and analytics

The profile page shows key information about your data such as your latest reviews and data analysis such as most read category, total number of pages read, etc.

Requirements to run the project

Before you run the project, check if you have [Node.js](https://nodejs.org/en/) installed on your machine, as well [Git](https://git-scm.com) to clone this repository.

Don't forget to create a ".env" file to include DATABASE_URL, GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET and NEXT_AUTH_SECRET.

Running the application

    # Clone this repository on your machine:
    $ git clone https://github.com/vitorlinsbinski/bookwise.git

    # Access the project folder in your terminal:
    $ cd bookwise

    # Install all dependencies:
    $ npm install

    # Run the application:
    $ npm run dev

Main Technologies

• ReactJS
• NextJS
• TypeScript
• Axios
• Stitches
• Radix UI
• Phosphor React
• NextAuth
• ZOD
• React Hook Form
• React Query
• Prisma ORM

Final Result

Login page

/login

Home page

/

Explore Page

/explore

Profile Page

/profile

Book Modal

Deploy

Check out the project working: https://bookwise-six.vercel.app/login

Contributing Guidelines

Contributions are welcome! Whether you want to fix a bug, add a new feature, or improve documentation, your contributions are valuable.

1. Fork the Repository

Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine using the following command:

git clone https://github.com/your-username/bookwise.git

3. Create a Branch

Create a new branch for your contribution:

git checkout -b feature/your-feature-name

4. Make changes

Make your desired changes to the codebase. Ensure that your code is working well without problems or bugs.

5. Test your changes

Before submitting a pull request, test your changes thoroughly to ensure they work as expected.

6. Commit and Push

Commit your changes and push them to your forked repository:

git add .
git commit -m "Add your descriptive commit message here"
git push origin feature/your-feature-name

License

This project is licensed under MIT License.

Author

_{Vitor Linsbinski} 🚀

Developed by Vitor Linsbinski