Library Rec Task

A library management application, developed as recruitment task for iris nitk
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Issues
• License
• Contact

About The Project

The project is a library management system built using Django and deployed on heroku. It allows management of resouces and is primarily divided into two sections

1. Member Portal
2. User Portal

Built With

• Django
• Heroku
• Bootstrap4

Getting Started (install is optional you can access the website here Deployed Demo)

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• python
• Django
• Pip
• Virtual Env

Installation

1. Clone the repo

git clone https://github.com/addhyanmalhotra/IRIS_RECTASK_LIB.git

2. Create and activate venv

• Windows

  $virtualenv myenv
  $ .\myenv\Scripts\activate

• Linux MacOS

  $virtualenv myenv
  $source myenv/bin/activate

3. Install Requirements

pip install -r requirements.txt

4. Runserver

python manage.py runserver

5. Open in browser

Usage

login credentials(uname,pass) Staff account : admin, admin user account : 191cs202, irisrecs

Member

The landing page leads you to the member dashboard, this shows basic project information like UML structure and has menu options loging in gives you access to

• Request Borrowing
• Check Active Requests
• View available books

Librarian

From landing page navigate to admin site

User Management

• You can add users (members) from user section
• You can change user info
• You can delete existing Users

Resouce managment

• Library recources can be managed from LMS section
• New books to be uploaded under Book Instance
• Issue requests show you existing requests along with appropriate filters you can aprove reject and delete reques once approved a new transaction will be created
• Transactions list the Book transactions made (Each of the above resouces can be exported to CSSV from respective dashboards)

Roadmap

• Lazy Loading (Django Lazy loads query sets by default :))
• Impliment PWA
• Setup a proper CDN ( not required unless scaled)
• CSV export of Models
• Simple responsive UI (using bootstrap)
• Clean Modern UI (using react)
• Single Table for User and Admin
• Migrate to NoSql for Book model (Details like description ISBN etc) while keepking transaction details in SQL format
• Optimise Tables

Issues

• Chrom reports security breach on logging in as admin (happens cuz uname=admin pass=admin is a very insecure cred, will be updated after demo)
• Author Details Table not implimented
• Password Reset UI not implimented
• Deployment and Local repo use same database (bad practice)

License

Distributed under the MIT License. See LICENSE for more information.

Refernces

• Start Bootstrap

• Django - Docs

• white noise docs

• Heroku Docs

• Beginners Gude to kick ass readmes

• Deploying on Heroku SimplebetterthanComplex

Contact

Addhyan Malhotra - [email protected]

Project Link: https://github.com/addhyanmalhotra/IRIS_RECTASK_LIB