Bingle

Bingle - A book lending app built using Django, Python, HTML, and JavaScript. Deployed on Kubernetes and Docker.

Objectives

Bingle originated from the minds of University of Sussex students, initially as a modest academic project. Yet, it quickly evolved into a beacon of sustainability and community for book lovers. Beyond assessment criteria, it now promotes healthy book exchange, fostering connections and saving budgets.

Website

Portal can be accessed from Bingle

Documentation

• Project Plan
• Reflective Essay
• Technical Documentation

Code Docstrings

• Code docstrings have been generated using Sphinx that describes all our function and can be found here.

Issues

All the tickets opened for bugs and issues can be found Here.

Connect with Us

Follow us for more exciting future projects below:

• Rohan Kadam
• Tom Naccarato
• Jawad Nasar Shah
• Mya Lwin
• Moldir Zhumakhazhi
• Rob Ryan

Local Installation Guide

Install Visual Studio Code (VSCode):

Step 1

Go to the official VSCode Website Download the installer for your operating system (Windows, macOS, or Linux). Run the installer and follow the installation prompts. Install PyCharm (Optional):

OR

If you also want to install PyCharm Community Version, go to the official PyCharm Website Download the installer for your operating system. Run the installer and follow the installation prompts.

Step 2

Download our project and Extract the Zip Source Folder : Locate the source folder you want to extract. Right-click on the folder and choose "Extract" or use a zip utility program to extract the contents. Open the Project Folder in VSCode:

Step 3

Install Python Packages from requirements.txt: Open a terminal or command prompt. Navigate to the project directory where requirements.txt is located. Run the following command to install the required packages:

pip install -r requirements.txt

Step 4

Launch VSCode. Click on "File" in the menu and select "Open Folder". Navigate to the location where you extracted the source folder, select it, and click "Open".

Step 5

Open a terminal within VSCode (click on "Terminal" in the menu, then "New Terminal"). Navigate to the project directory (where manage.py is located). Run the following command to start the Django server:

cd Bingle ; python manage.py runserver

OR

cd Bingle ; python manage.py runserver 0.0.0.0: xxxx ( Replace xxxx with any port you want to use to run the server on aside from default 8000)

Now open a web browser and browse the following address:

http://localhost:8000 or http://127.0.0.1:8000

The server should now be running, That's it!!. Enjoy playing !!