A simple and intuitive application where users can add, rate, and manage books in their personal accounts. Admins have special privileges to view all user activity, but not modify ratings.
The following features need to be implemented or improved as part of the ongoing development:
-
User Registration and Login
- New users sign up with an email and password.
- Existing users log in with an email and password.
-
Book Management
- Add and remove books.
- Each book has a name, author, and a rating (1 to 5).
- Users can update their book ratings.
- Filter books by rating.
-
Admin Dashboard
- Admins see all books from all users.
- Admins can filter books by creation date.
- Admins can view ratings but not edit them.
-
Clean UI/UX
- Focus on a user-friendly, clean, and visually appealing interface.
- All actions, including adding/removing books, rating, filtering, and managing user data, are executed via a RESTful API.
- Additional features will be rolled out as we improve the app. Stay tuned, and feel free to contribute!
We welcome contributions! Follow these steps to contribute to the project:
-
Fork the Repository
Click the "Fork" button at the top right of the repository page to create a copy of the repository under your GitHub account. -
Clone Your Fork Locally
Once you've forked the repository, clone it to your local machine using the following command:git clone https://github.com/yourusername/book-rating-app-assignment.git
-
Create a New Branch
It's good practice to create a new branch for each feature or bug fix you're working on:git checkout -b feature/your-feature-name
-
Make Your Changes
Implement your changes locally. Be sure to follow any coding standards or guidelines provided by the project. -
Commit and Push Your Changes
After making changes, stage and commit them:git add . git commit -m "Describe your changes"
-
Push your changes to your forked repository:
git push origin feature/your-feature-name
-
Create a Pull Request
Once your changes are pushed, go to the original repository on GitHub and open a Pull Request (PR). Describe your changes and why they should be merged. The project maintainers will review your PR, and once approved, it will be merged into the project. -
Wait for Feedback
The maintainers may request changes or provide feedback. Be sure to follow up on any requested changes before the PR is merged.
We are excited to participate in Hacktoberfest 2024! If you'd like to contribute to this project during Hacktoberfest, here’s how you can get involved:
-
Solve Issues with Hacktoberfest Tag: Look for issues labeled with the Hacktoberfest tag. You can help by resolving these issues and submitting a pull request (PR) with your changes.
-
Submit New Issues: If you find a bug or have an idea for a new feature, please create a new issue. Describe the issue or feature request clearly, and once it's documented, feel free to submit a pull request with your implementation. I will tag your PR with the Hacktoberfest tag once it's ready.
For detailed instructions on how to contribute, please check out the CONTRIBUTING.md file.
Let's make this project even better together! 🎉