Lion City Soundscapes Visualisation

NTU Final Year Project 2023. Grade Attained: A+

A Django web application that visualises characteristic soundscapes of Singapore on an interactive Leaflet map. This project was done as part of my Final Year Project (FYP) Bachelor of Honours requirement at NTU and is part of the project 'Lion City Soundscapes'. More information on the project can be found at https://doi.org/10.21979/N9/AVHSBX. This repository comprises of the code used to develop the web application and includes instructions to install the project locally. The web application has been deployed on Amazon EC2 and can be viewed live at https://tinyurl.com/fyp-lcs.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap

About The Project

Built With

• Python (version 3.11.0)
• Pip (22.3.1)
• Django
• LeafletJS
• OneMap
• Javascript
• HTML/CSS

(back to top)

Getting Started

Prerequisites

To ensure that the project runs smoothly, please make sure you have the following dependencies installed on your system:

• Python: This project is built with Python version 3.11.0. You can download the latest version of Python from the official website. To check if you have the correct version of Python installed, open a terminal or command prompt and run the following command:

  python --version

  This will display the installed version of Python. To ensure the project runs smoothly, please ensure your version of Python is 3.11.0 or newer.

• Pip: Pip is the package installer for Python. To check if you have pip installed, you may run the following command line in your terminal:

  pip --version

  This will display the installed version of Pip. To ensure the project runs smoothly, please ensure your version of Pip is 22.3.1 or newer.

  
  
  

Installation

This README.md is still being updated. Please note that the installation instructions are written for Windows machines only. Installation instructions for other OS will be updated in the future.

Step 1: Setting up and activating the Virtual Environment

Python virtual environments help to create an isolated environment for development, where you can install dependencies, and other required third-party packages. Once Python has been installed, create a new Python virtual environment called env with the following command line in your terminal:

python -m venv env

Next, activate the virtual environment with the following command:

env\Scripts\activate

We can now install Django within the virtual environment with the following line:

pip install django

Step 2: Installing the Project

Clone the repository by downloading it from https://github.com/nemopotatoes/Lion-City-Soundscapes-Visualisation, or enter the following command on a terminal (with git installed):

git clone https://github.com/nemopotatoes/Lion-City-Soundscapes-Visualisation.git

You may navigate to the project folder in the terminal, where path/to/ is the directory of the folder:

cd path/to/Lion-City-Soundscapes-Visualisation

Install project dependencies in the project's directory with the following command (make sure you have pip installed for this step):

pip install -r requirements.txt

Step 3: Running the Project on a Local Server

You may run the project on a local server by entering the following line in the project directory /path/to/Lion-City-Soundscapes-Visualisation. Please make sure you have python installed for this step.

python manage.py runserver

The project can be viewed on your local server at http://127.0.0.1:8000/

To stop the server, press Ctrl+C in your keyboard in the same terminal.

(back to top)

Roadmap

• Define user requirements
• Web Application Design
  • User interface template
  • Wireframes and storyboards
• Set up Django project
• Set up Leaflet interactive map
• Finalise soundscape recordings (locations.csv)
• AWS Deployment (EC2 Free Tier)
• Other Pages (About, Resources, Recordings, Contact)
• Functional Testing

(back to top)