Skip to content

debashis1312/Gyanchakkhu-admin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gyanchakkhu Logo

📚 Gyanchakkhu Admin Portal

Gyanchakkhu Admin Portal is a web application designed to simplify library management for administrators. This portal complements the Gyanchakkhu mobile app, offering a seamless way for library authorities to manage users, books, and transactions. It serves as a powerful admin panel to oversee and streamline library operations.


🌟 Features

🎯 Admin Functionality

  • User Management: View and manage all user details, including issued and submitted books.
  • Book Management:
    • View books currently available in the library.
    • Track issued and submitted books.
    • Register new books with relevant metadata.
  • Search Bar: Quickly search for books by title, author, or category.
  • Position Assistance: Locate books in the library and ensure proper shelving.

📱 Complementary App Features

The Gyanchakkhu Mobile App enables:

  • QR-based book issuance and submission.
  • AI-based video verification for book condition during submission.
  • In-app navigation to locate books in the library.
  • Restricted QR functionality, ensuring security by enabling scanning only within library premises.

👨‍💻 Developer Instructions

🗂 Component Folder Structure

  • Organize components in well-named folders under the components directory.
    • Example:
      • Home Page: HomeModule folder
      • Login and Register: AuthModule folder
      • Navbar and Footer: CommonModule folder
  • Avoid creating unnecessary folders.

🖼 Images

  • Place images in the public folder, preferably in SVG format.
  • Use a dedicated local folder for non-SVG images when necessary.

🖋 Code Quality

  • Write minimal and clean CSS to avoid over-styling.
  • Write dedicated CSS files for different modules to ensure encapsulation and prevent style conflicts.
  • Ensure the code is accurate and efficient.

🔗 GitHub Pull Request (PR) Rules

  • Follow the organization’s GitHub pull request rules.
  • Refer to the Contributing Guidelines and Code of Conduct for proper contribution practices.

Queries or Doubts

For any issues, reach out to Parnab Bagchi.


🔗 Related Projects

Looking for the mobile app? Check out the Gyanchakkhu Mobile App:

👉 Gyanchakkhu Mobile App GitHub Repository


📋 Contributing to the Project

We welcome contributions! If you'd like to get involved, follow these steps:

  1. Star and fork the repository.
  2. Clone the repo and create a new branch for your changes.
  3. Refer to the Contributing Guidelines for detailed instructions.
  4. Follow the Code of Conduct to maintain a collaborative environment.
  5. Submit a well-documented pull request (PR).

💡 Getting Started

  1. Clone the repository:
    git clone https://github.com/<your-username>/Gyanchakkhu-admin.git
    cd Gyanchakkhu-admin
    cd Frontend
  2. Install dependencies:
    npm install
  3. Start the development server:
    npm run dev

🛠 Tech Stack

  • Frontend: React.js using Vite, Tailwind CSS, Bootstrap CSS
  • Backend: Node.js, Express.js
  • Database: Not disclosed
  • AI Integration: Not disclosed
  • Version Control: Git and GitHub

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.


🙌 Acknowledgments

Special thanks to all contributors and the Gyanchakkhu Team for making this project possible. Together, we’re revolutionizing library management! 🚀

About

The ultimate librarian at your fingertips.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 57.2%
  • CSS 39.3%
  • HTML 3.5%