README.md

NUS-NCS-Hackathon-2024

Team Name: InnovateX.

Project Description: Using LLMs to interpret, predict, and manage crowd control.

Usage:

Recommendation:

• Windows or Linux operating systems.

Requirements:

• Docker installed on your local machine.
• acquire API keys from LTA Datamall and HERE Technologies (need to edit python_tokens.py)

Installation:

1. Clone Repository:

   • Clone the repository to your local machine:

     git clone https://github.com/J0JIng/NUS-NCS-Hackathon-2024
     

2. Navigate to Project Directory:

   • Open your terminal and navigate to the project directory:

     cd /mypath/NUS-NCS-Hackathon-2024
     

3. Build Containers individually:

   • Build the container for the backend:

     cd backend
     docker build .
     

   • Build the container for the front-end:

     cd ../frontend
     docker build .
     cd ..
     

     (note: npm install might take a while)

4. Optional, Use Script for Building:

   • If you prefer, you can use the provided script to start the containers. For Linux, you can use the script start_script.sh.

     ./start_script.sh
     

5. Build Docker Containers collectively:

   • Use the following command in the terminal to build the Docker containers:

     docker compose build
     

6. Run Containers:

   • After building the containers, run them using the following command:

     docker compose up
     

7. Access Web App:

   • Once the containers are running, open your favorite web browser.
   • Navigate to:

     localhost:19006/
     

Note:

• It might take a little a while to load the response from Gemini.