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.
python3
pip3
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
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/files
cd make_folder
python make_folder.py
mv DATA/* ../media/database/
cd bookShelf
python manage.py migrate
python manage.py createsuperuser (Create a super user by following the instructions)
deactivate
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 localhost:8000
For admin page go to localhost:8000/admin/
- 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.
Before making ANY CHANGE in the REPO:
Make sure to commit changes from the VM and then make any changes. And after making any changes on your local machine, please commit the changes and pull them in the VM.
Go to /books/approve
and accept or reject or rename each request
PS: You must be logged in to do that ;)
Tracking and Page hits are currently implemented in two ways:
- Google Analytics - Currently, Google analytics is operational for study.devclub.cse.iitd.ac.in/
- Admin Panel - Course Page hits can also be found from the admin panel. Go to the requisite course code and check the pagehits field
* /books/api/structure/ : would return the whole directory structure