Data Model for the webapp and implementation details
What is it all about?
We bring to you one of its kind crowd contributed portal. For the students, by the students and of the students. It acts as a one stop platform for all the learning that you will need. Share, learn and go. Currently the workpattern is this, people contibute using the upload button, this dumps the file in media/unapproved. Using the approve page authorised people can add the papers.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The following packages are required on a linux machine to compile and use the software package.
course.json --> File that lists all the courses profs.json --> File that maps uids of Profs to their Names
Deploying bookShelf is fairly simple. Just issue the following commands on a linux machine You need crontab installed at your system for the required cronjobs to work
git clone https://github.com/devclub-iitd/bookShelf.git cd bookShelf python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt mkdir media mkdir media/database mkdir media/unapproved mkdir media/bulk cd make_folder python make_folder.py cp -r DATA/* ../media/database/ cp -r DATA/* ../media/bulk/ cd ../bookShelf python manage.py migrate python manage.py createsuperuser (Create a super user by following the instructions) python manage.py crontab add python manage.py collectstatic --noinput deactivate
Running the Web-App
You can run the code using the command:
cd bookShelf source venv/bin/activate cd bookShelf python manage.py runserver
Thereafter, go to the home page at
For admin page go to
How to approve and disapprove requests?
/books/approve and accept or reject or rename each request
PS: You must be logged in to do that ;)
- Python 3.6 - Python is a programming language that lets you work quickly and integrate systems more effectively.
- Django 1.11.1 - The web framework for perfectionists with deadlines.
Tracking and Page hits are currently implemented in two ways:
- Google Analytics - Currently, Google analytics is operational for study.devclub.iitd.ac.in/
* /books/api/structure/ : would return the whole directory structure