The Good Read Project is a full-stack web application that allows users to categorize books and authors, manage their reading progress, and review books. The application also includes features such as showing related books and book details. The Admin user has complete control over the application and can perform all CRUD operations on books, authors, and categories.
The Good Read Project was built using the following technologies:
- React
- Material UI
- Node.js
- Express.js
- MongoDB
To run the application locally, follow these steps:
- Clone the repository:
git clone https://github.com/your-username/good-read-project.git - Install the dependencies:
npm install - Start the server:
npm start - Start the client:
cd client && npm start
Note: You will need to have Node.js and MongoDB installed on your machine to run the application.
The Good Read Project includes the following features:
- Categorize books and authors
- Manage reading progress
- Review books
- Show related books
- Show book details
- Admin user with full CRUD operations on books, authors, and categories
To use the application, follow these steps:
- Register as a user or login if you already have an account.
- Browse the available books and authors.
- Add books to your reading list by selecting the "Want to Read" option.
- Move books to the "Currently Reading" or "Have Read" shelves as you progress through them.
- Leave reviews and ratings for books you have read.
- Browse related books and view details for each book.
- If you are an admin user, you can perform CRUD operations on books, authors, and categories.
If you would like to contribute to the project, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b my-new-branch - Make your changes and commit them:
git commit -m "Add some feature" - Push to the branch:
git push origin my-new-branch - Create a new Pull Request.
The Good Read Project is licensed under the MIT License. See the LICENSE file for details.