Skip to content

Sundaram-Katare/BookHub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 

Repository files navigation

BookHub - A Bookshelf App

  • BookShelf is a MERN stack web application where users can view, add, and explore books added by others.
  • Each book displays who added it, and clicking on a book reveals its author and cover image in a modal. Authentication is required to add books.

✨ Features

  • 🔐 User authentication (JWT-based)
  • 📖 View list of books with contributor names
  • 📌 Click any book to see author & cover image in a popup
  • ➕ Authenticated users can add new books
  • 📦 Built with React, Tailwind CSS, Node.js, Express, MongoDB

🚀 Live Demo

https://book-hub-seven-smoky.vercel.app/


📷 Preview

image

🧑‍💻 Tech Stack

  • Frontend: React, Tailwind CSS, React Router
  • Backend: Node.js, Express.js
  • Database: MongoDB (with Mongoose)
  • Auth: JWT, bcryptjs

📁 Project Structure

BookShelf/
├── client/         # React frontend
├── server/         # Express backend
└── README.md

Local Setup Instructions

  1. Fork the repo
  2. Clone the forked repo
  git clone https://github.com/your-username/BookHub.git
  cd BookHub
  1. Setup Backend

i)

   cd server
   npm install

ii) Create a .env

  PORT=5000 
  MONGO_URI="your-mongodb-connection-string"
  JWT_SECRET="your_jwt_secret"

iii) Run Server

 node server.js
  1. Setup Frontend
    cd ../client
    npm install
    npm run dev

Frontend will run at http://localhost:5173

Backend at http://localhost:5000

🧑‍🤝‍🧑 Contributing

Thank you for considering contributing to BookHub App! Whether you're fixing bugs, improving the UI, or adding new features — your contributions are highly appreciated. ❤️


📌 Start with Issues

Before jumping in, head over to the Issues section of this repository.

✅ I’ve already created multiple issues that are ready to be picked up.
🗨️ If you find an issue you'd like to work on, comment on it saying:
I want to work on this issue.
Then, you can start working on it. Once done, You can raise the PR for it.

✨ You’re also welcome to raise new issues if you spot a bug or have an idea for improvement — just make sure to provide enough context!


🚀 How to Contribute

Follow these steps to contribute to the project:

  1. Fork this repository by clicking the Fork button on the top right.

  2. Clone your forked repo to your local machine:

    git clone https://github.com/your-username/bookhub.git
    cd bookhub
  3. Create a new branch for your feature or fix:

  git checkout -b your-feature-name
  1. Make your changes in the codebase.
  2. Stage and commit your changes:
git add .
git commit -m "feat: meaningful commit message"
  1. Push your branch to your GitHub fork:
git push origin your-feature-name
  1. Raise a Pull Request from your fork to the main branch of this repo. Go to your fork on GitHub → Click Compare & pull request → Fill the PR form and submit.

📝 Tips for a Great Contribution

  • Keep pull requests focused on one issue or feature.
  • Add clear and concise commit messages.
  • Share screenshots or video demos for UI changes (if applicable).

🙌 Thank You

Every contribution, no matter how small, brings value to this project and helps others learn. Let’s build something awesome together! 🚀


🙋‍♂️ Maintainer

Sundaram Katare Connect on:-


🫂 Contributors

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors