Welcome to Informatician, an open-source book platform where literature meets community, and knowledge knows no bounds. Our web application is designed to revolutionize the way you engage with books, offering a comprehensive book listing and reading experience similar to popular platforms like Kindle and Scribd.
The application goes beyond a mere reading experience, as it allows you to rate and review books, fostering a sense of community and sharing insights with fellow book enthusiasts.
You can explore a vast collection of books, search for your favorite titles, and even contribute by adding new books to the platform. Whether you're an avid reader, a literary connoisseur, or simply seeking new knowledge, Informatician is here to provide you with an exceptional platform to explore, learn, and connect.
- Book Contribution: Contribute to the platform by adding new books, enriching the library for the entire community to enjoy.
- Comprehensive Book Listing: Explore a vast collection of books from various genres and categories, including fiction, non-fiction, science fiction, fantasy, biographies, and more.
- 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 authorization.
- Responsive Design: The application features a responsive design, making it accessible and visually appealing across various devices, including desktops, tablets, and mobile phones.
Before proceeding with any implementation or changes, it is crucial to thoroughly review the discussion tab and familiarize yourself with the site plan. By doing so, you can align your work with the intended direction of the platform and contribute effectively. Please take the time to read through the discussions and gather necessary information before proceeding. Thank you! #330 you can refer
- Clone the repository:
$ git clone https://github.com/rohansx/informatician.git- Install dependencies:
$ npm install- Create a
.env.localfile and add the following:
MONGODB='YOUR_MONGO_CREDENTIALS'Note: Get your Mongodb credentials from here
- Start the application:
$ npm run dev💻 The application can be accessed in a web browser at http://localhost:3000.
Prerequisites:
Before running the application with Docker, make sure you have the following prerequisites installed on your machine:
Docker: Follow the instructions specific to your operating system to install Docker. You can find the installation guide at https://docs.docker.com/get-docker/.
Docker Compose: Docker Compose is typically installed along with Docker. However, if you don't have it installed, you can find installation instructions at https://docs.docker.com/compose/install/.
Clone the repository:
git clone https://github.com/rohansx/informatician.gitNavigate to the project directory:
cd informaticianStart the application using Docker Compose:
docker-compose upDocker Compose will build the necessary containers and start the application. It may take a few moments to download and configure all the required dependencies.
Once the containers are up and running, you can access the application in a web browser at http://localhost:3000.
That's it! Now you have the app running locally using Docker. Enjoy exploring the application!
Note: If you make any changes to the codebase, you will need to rebuild the Docker containers using the below command to apply the changes.
docker-compose up --build- Go through the CONTRIBUTING.md file, where all the guidelines have been mentioned that will guide you to make your contribution.
- Do checkout the Code of Conduct section.
✨ If you have any questions or need assistance, feel free to open an issue in the repository.
Join us on this open-source journey, and let your love for books flourish in a limitless world of possibilities.
🙏 Thank you for your exceptional contribution. We look forward to your continued involvement and collaboration as we strive to enhance Informatician and provide an exceptional book platform for users around the world.
🌟 We value the time and effort you put into contributing in improving Informatician and helping us create a vibrant and user-friendly environment for book enthusiasts, and we look forward to reviewing and merging your contributions. Your dedication, skills, and commitment have played a crucial role in making Informatician the incredible platform it is today.
✨ Once again, thank you for your contribution!
Rohan Sharma - Main Developer
The project is licensed under the MIT License.