/library-management

A Full Stack library management web app, built with the JS MERN stack.

Primary LanguageJavaScript

Library Management App

Current version: v1.1

This is a simple fullstack web app for library management, built using the MERN stack.

Table of Contents
  1. About the project
  2. Getting Started
  3. Help
  4. Authors
  5. File Structure
  6. Gallery
  7. Version History
  8. License
  9. Acknowledgments

🔰 About the project

The system allows Librarians and Members to login to the web app (using accounts created by librarians)

Lbrarians can:

  • Manage (CRUD)
    • Authors
    • Genres
    • Books
    • Borrowals
    • Users

Members can:

  • View (R)
    • Authors
    • Genres
    • Books
    • Own borrowals
  • Add (C)
    • Own borrowals

Built with

MongoDB Node.js NPM React Git Github VS Code HTML CSS JS

⚡ Getting Started

❕ Prerequisites

You need a computing environment with an up to date version of Windows/Mac OS/Linux and a working internet connection

  • Git
  • Node.js
  • NPM
  • A web browser (Chrome/Edge recommended)

🔻 Downloading

  • Clone the code repo using HTTPS, SSH or Github CLI
git clone https://github.com/ennas-de/library-management.git

🚀 Installing and executing (dev)

You will need the .env file containing the environment variables in order to use the system, please contact the authors

  1. cd to project folder (LibraryManagement)
  2. Run the following commands in terminal:
  • To install NPM packages
npm run install
  • To start both server and client applications
npm start
  1. Use the following demo accounts to login
  • Librarian
Email address: testlibrarian@library.com
Password: librarian123
  • Member
Email address: testmember@library.com
Password: member123

❓ Help

Contact authors if you need help or run into any issues

👥 Author

📂 File Structure

.
├── client
│   ├── public
│   │   ├── assets
│   │   └── index.html
│   └── src
│       ├── hooks
│       ├── sections
│       │   ├── @dashboard
│       │   │   ├── app
│       │   │   ├── author
│       │   │   ├── book
│       │   │   ├── borrowal
│       │   │   ├── genre
│       │   │   └── user
|       │   └── auth
│       │       └── login
│       ├── utils
│       ├── App.jsx
│       ├── index.js
│       ├── constants.js
│       └── routes.js
│
├── server
│   ├── controllers
│   ├── models
│   ├── routes
│   ├── index.js
│   └── passport-config.js
│
├── package.json
├── README.md
└── LICENSE.md
  • Only the core files and directories are shown in the above tree
No File Name Details
1 server/index.js Node.js server app entry point
2 client/src/index.js Client react app entry point

📄 Version History

🔒 License

This project is licensed under the MIT License - see the LICENSE.md file for details

🌟 Acknowledgments

Frontend React UI Template