open-xyz/informatician

Unleash an open source book platform where literature meets community, and knowledge knows no bounds.

INFORMATICIAN - An Open Source Book Reading Platform

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.

---

Table of Contents

• Features
• Tech Stack
• Installation
• Contributing
• Authors
• License

---

Features

• 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.

Tech Stack

Note:

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

✨ How to install it?

1. Clone the repository:

$ git clone https://github.com/rohansx/informatician.git

2. Install dependencies:

 $ npm install

3. Create a .env.local file and add the following:

MONGODB='YOUR_MONGO_CREDENTIALS'

Note: Get your Mongodb credentials from here

4. Start the application:

 $ npm run dev

💻 The application can be accessed in a web browser at http://localhost:3000.

✨ Running the Application with Docker

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.git

Navigate to the project directory:

cd informatician

Start the application using Docker Compose:

docker-compose up

Docker 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

✨ Contributing Roadmap

• 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 Contribution!

🙏 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!

✨ Authors

Rohan Sharma - Main Developer

✨ License

The project is licensed under the MIT License.

Back to Top

Deployment of React branch

https://react.informatician.in/

informatician's Issues

LOGIN AND SIGN IN PAGE WITH FIREBASE

can you assign this to me, I want to work on this under GSSoC'23

Adding books to a database using Node.js

I'd like to create a form that allows adding books to a database: (GSSoC'23)

Form may contain fields such as:

1. Name of the Book
2. Category
3. Short summary (optional)

Integrate the frontend with the server.js

for now if we start the project we are having this output on the screen.

there is a file named Ap..js which contains basic structure link it such that on start that structure should come to display on the main page.

Add Backend Directory and Implement Search API for books by Title, Author, Prefix Keyword, or Category.

There is no Backend Directory yet, so I want to add Backend Stuff with Package file.
Please assign me! @rohansx

The About us link in the footer doesn't redirect to the about us page.

The footer link of about us is not working.

Make Navbar and Footer for all pages

Make navbar and footer common for all pages like about books etc. i.e for component folder

Add Breakpoints for Responsive designs

Add various break points for mobile, tablet pc's, and large desktops. To make the site responsive.

Make simple web page with navbar and footer

• Make simple layout for book listing site.

Documentation updation required

The README file looks less communicating and needs other features to be included like tech stack and images of the project. This can be done in a very impressive way.

Add searching Option and design.

Add a text-box and searching option in the design.

add readme badges

I want to add readme badges..Please assign this issue to me under GSSOC

Add rating and reviewing Feature.

Suggest a design for rating and reviewing feature , and also add it at a good location so that it is visually and functionally good.

Fixing Footer Styling

I would like to improve footer's UI

Create readme.md

create and provide readme.md for open source book listing web application using nodejs

Design a good About section for this project

@rohansx please provide the details me must add in our about section
provide the content for that.

Home section css bug

When we click on home section header comes below footer. I want to fix this bug

Report bug from the footer.

The support section from the footer contains a component of Report Bug we can make the user file an issue on GitHub if there's any bug in the website. It'll redirect the user to file an issue directly to GitHub.

Adding responsiveness

I would like to request that the responsiveness of the project be improved. This would make the project easier to use on devices with different screen sizes and resolutions.

The benefits of improving responsiveness are:

It would make the project easier to use on devices with different screen sizes and resolutions.
It would make the project more user-friendly.
It would improve the overall user experience.

I believe that improving responsiveness would be a valuable addition to the project and would make it more user-friendly. I hope you will consider my request.

Search functionality in the backend and creating routes.

I would like to implement search functionality of books in the backend using MongoDB and nodejs. I would also create routes for the app.

Please assign me this issue under GSSOC' 23.

Naming issue of the website

The title of the website is Informatician while on the navbar it is written book listing app. The name should be the same in both places. I would like to contribute to this issue under GSSOC'23. Please assign me this issue.

Make header responsive

Make header responsive for all screen sizes

[FEAT] Custom Error Page 404

I will design an Error Page for calls or redirecting to pages which do not exist.

Hello!
I am Viraj Chandra, a proud contributor at GSSoC '23. I would like to the contribute to this project by designing an Error Page for calls or redirecting to pages which do not exist.

Things I will be doing as of now:

• Designing the error page 404

@rohansx Please Assign me this.

[GSSOC'23] Adding Dark Mode for the website

We will enhance the user experience by implementing Dark Mode for our website. This feature will offer a visually appealing alternative color scheme, providing a more comfortable browsing experience in low-light environments and reducing eye strain. Dark Mode will not only enhance accessibility but also add a modern and stylish touch to our website's design.

Book section

I want to redesign book section

Implement these UI features for homepage

Refer to this site https://www.scribd.com/home and try to make UI like that.

• Add a search box and symbol button
• Add only book categories(e.g sci-fi, self-help, spiritual,etc). As shown in the screenshot make use of "card" to list down categories
  
• UI should look clean. Make it in black and white color mostly with standard look and design. Use text-shadows, box-shadows, and many more.. refer to this site for font-size, font-style, button color and design https://www.zestmoney.in/

design about us page

I want to design about us page. Features:

1.similar navbar and footer
2.about us info
3. repo owner card

Please assign this issue to me under GSSOC

Improving the footer file of this project

I would like to work on improving the footer file of this project making it engaging and expressive for the users.

Create an issue

If you have any idea and suggestion, feel free to create an issue

Handle the Home page UI(Margin & padding) and add some styles

I will create jumbotron and mange the UI (margin and padding) when website loads in mobile view.
can you assign me this role ?

Improving the UI

Hey @rohansx As I can see currently your website seems very bad and there is nothing related to books. I want to give your website a whole new look. please assign me this issue and you'll not regret it. Thank you!

Improving the readme file of this project

I would like to improve the readme file of this project making it engaging for the users and make it more expressive.

Improving book section

The feature I am suggesting is a way to fetch books from the a books API. This would allow users view books from the books catalog.

Add an About section

Add about section for the project where user can understand what this project is.

Backend api for authentication

There is no backend api for signup and signin of user. i want to add backend api for authentication so that user can sign up and sign in in the application using nodejs.
Please assign me this issue under gssoc'23.

Change the name of contribution.md

Change the name of contribution.md to contributing.md

add contributors graph

I want to add contributors graph in readme.Please assign this issue to me under GSSOC.

Add routing in the App.js for proper navigation through navbar

Want to add List of Books in the Books Section #gssoc 23

Please assign me

Add a scroll to top navigation button

There is an absence of a scroll-to-top button on the website. The website's user experience would be improved by the addition of this floating button.
Due to my prior experience in building for personal projects, I'd like to contribute this feature.

Please assign me the task under GSSoC'23.

Updating the Title

By resolving this issue and updating the project title, we aim to enhance clarity and coherence, providing users with a more accurate representation of the content and purpose of the project. This will improve the overall user experience and avoid potential confusion or misunderstandings.
I would like to work on these issue.

create contributing.md file for this repository

Refactor the code to use React router dom

We can enhance the performance of the app and avoid unnecessary refresh of the page using the react-router-dom. This will allow user to easily navigate between different pages.

Welcome Page

If a user enter this website at first we can not directly show home page or any pages.Instead showing that we can land to user welcome
page or Login in this website for exploring more.
Assign this work to me.

Create navbar and footer

create navbar and footer. Refer https://www.scribd.com/ for the UI design for header and footer

Fix incorrectly written code

I request to be assigned the task of rectifying the improperly written code by converting it into functional-based components. Additionally, I will organize and improve the file structure accordingly. Thank you.

Improve the footer

I want to make the footer responsive and the newsletter section would be center

Improve like this

Responsive Footer and Navbar

I want make the website for mobile

the problem is

i want to fix this

Adding light and dark theme

I would like to request that a dark and light theme be added to the project. This would allow users to choose the theme that best suits their preferences.

The benefits of adding a dark and light theme are:

• It would make the project more visually appealing.
  

• It would make the project more accessible to users with visual impairments.
  

• It would save battery life on devices with OLED screens.
  

I believe that adding a dark and light theme would be a valuable addition to the project and would make it more user-friendly. I hope you will consider my request.

Adding Your Own Book Database

As by seeing your Website I assume the most important thing needs to be done is the backend part

What I can Provide

1.) I can create a mongodb database where you can save your files and fetch them into the website
2.) Also can Create a Better UI afterwards for the Books Section
3.) Let me if you want me to find some API to directly fetch them.
4.) Also Your Footer is just not functional so I can do that too.

At last for Improvement of UI I require Tailwind css , Let me know if you mind it.

Therefore, I request you to assign me the above tasks under GSSOC'23

Thank you

ADD BOOK COMPONENT

I would like to design the frontend of "ADD BOOK COMPONENT"

• ADD BOOK Component will be a page where user if authenticated can add a book to the database
• A form to add book
• I would also like to design the backend for this but if anybody is already working on it I can collaborate with him/her

Please assign this issue to me

A demo from what I think book component should be