Informatician is an open-source web application designed to provide users with a comprehensive book listing and reading platform, offering a similar experience to popular platforms like Kindle and Scribd. The application allows users to search for books, add new books to the platform, rate and review books, and seamlessly read them within the application. Built using Node.js, Express.js, React.js, and MongoDB, Informatician aims to create an immersive and user-friendly environment for book enthusiasts.
- Features
- Installation
- Usage
- Contributions
- Contributing
- Things Necessary for Pull Requests
- Roadmap
- Authors
- Changelog
-
Add new books to the database
-
Admin panel for managing books and users
-
Extensive Book Search: Utilize the powerful search functionality to discover books by title, author, or category, enabling users to find their desired reading material effortlessly.
-
Personal Library: Users can curate their own digital library by adding new books to the platform.
-
Rating and Review: Share opinions and insights by rating and reviewing books.
-
Seamless Reading Experience: Enjoy a comfortable reading experience within the application.
-
Authentication and Authorization: User accounts with secure authentication and authorisation.
-
Responsive Design: The application features a responsive design, making it accessible and visually appealing across various devices, including desktops, tablets, and mobile phones.
- Clone the repository:
$ git clone https://github.com/openeon/informatician.git- Install dependencies:
$ npm install- Start the application:
$ npm start💻 The application can be accessed in a web browser at http://localhost:3000.
Informatician is powered by major contributions from the community. Template contributions , Feature Requests and Bug Reports are more than welcome.
Thank you for your interest in contributing to Informatician! We welcome contributions from the community to help improve the project. To contribute, please follow these steps:
-
Fork the repository: Start by forking the Informatician repository to your GitHub account.
-
Create a new branch: Create a new branch for your feature or bug fix. This helps in keeping your changes isolated from the main codebase.
-
Make your changes: Make the necessary changes or additions to the codebase. Ensure that your changes follow the coding conventions and best practices of the project.
-
Test your changes: Before submitting a pull request, test your changes to ensure they work as intended and do not introduce any regressions or bugs.
-
Commit your changes: Commit your changes with a descriptive commit message that clearly explains the purpose of your changes.
-
Push your changes: Push your changes to your forked repository on GitHub.
-
Submit a pull request: Go to the main repository of Informatician, and submit a pull request. Provide a clear and concise description of your changes, including any relevant information or context that can help the maintainers understand your contribution.
When submitting a pull request, please ensure the following:
-
Sync with Main Branch: Before creating a pull request, make sure to sync your branch with the main branch to incorporate any updates or changes that have been made since you started working on your code.
-
Detailed Description: Provide a brief but comprehensive description of the issue you are addressing with your pull request. Include any relevant information or context that can help the maintainers understand the purpose of your changes.
-
Screenshots: If your changes involve any visual modifications, consider providing screenshots or GIFs to showcase the before and after state of the application.
-
Testing: Make sure to test your changes thoroughly to ensure they work as expected and do not introduce any new issues. If applicable, include details of your testing process or steps followed to validate the changes.
-
Maintain Good Practices: Follow the established coding conventions, formatting guidelines, and best practices of the project. Ensure your code is readable, well-documented, and maintainable.
✅ This project is licensed under the MIT License
If you have any questions or need assistance, feel free to open an issue in the repository. <a name="roadmap"
Here are some potential features and improvements that can be added to the application in the future:
• User profile pages
• Social sharing options for books
• Book recommendation system based on user preferences
• Advanced search filters (e.g., by publication year, language)
• Book wishlist functionality
• Integration with external book APIs (e.g., Goodreads, Open Library) • Support for multiple languages
Feel free to contribute to any of these ideas or suggest new ones!
✅ Rohan Sharma - Main Developer
✅ See the Changelog file for details about the changes in each version of the application.
Thank you for your contribution! We appreciate your efforts in helping make Informatician better.
