CUThere

A website designed by LeFullstack that helps Carleton students navigate the tunnel network. Made with React.js, the website uses a custom 3D model diagram of the tunnels to show users their current location and the most optimal path to their destination. Each location in the tunnel has labels which denote their name, the buildings they link to, etc. A user could also potentially see their favourite room numbers and which tunnel exits/entrances connect to them. The website aims to be simple and quick to use so that students can quickly find their way around campus.

---

Getting Started

---

Prerequisites

(The installation for these prerequisites is covered in the Installing section)

• Python 3.11 or above
• Django Framework
• React
• FastAPI
• Uvicorn
• MapLibre
• DeckGL

Installing

Backend

1. Clone this repository with git clone
2. Open a terminal in the backend folder with cd backend
3. Install prerequisites with pip install -r requirements.txt & pip3 install "fastapi[standard]" uvicorn "djangorestframework-simplejwt[crypto]" for FastAPI, Uvicorn, and Django Framework + Django Token Auth
4. Create a file called .env in the backend folder with the value SECRET_KEY=SOMEVALUE where SOMEVALUE is from this website: https://djecrety.ir/

Frontend

1. Open a terminal in the frontend folder with cd frontend
2. run npm install
   • Will install all frontend node.js requirements, including React, MapLibre and DeckGL, and their dependencies
3. run npm run dev
4. The link to the local server will appear in your terminal

---

Deployment

Run both the Django server (/) and API (/api) with uvicorn termproject.api:app --reload

See that Django is running at localhost:8000, localhost:8000/admin, etc. and the API is running at localhost:8000/api

---

Built With

• Django - Backend framework
• FastAPI - API controller for sending data to frontend & map library
• React.js - Frontend framework
• Maplibre - Mapping Library
• DeckGL - MapLibre WebGL 3D integration

---

Contributing Authors

---

LeFullStack Team

• Baasit Nsubuga - Frontend Developer - Codeup22
• Caelan Douglas - Backend & Frontend Developer - caelan-douglas
• Cayden McMullin - Frontend Designer & Developer - decayed
• Kenneth Elly Hernandez - Backend & Frontend Developer - keaherna
• Mohamad Awad - Frontend Developer - YoNoRush
• Will Richards - Backend Developer - Landwich
• Vardaan Kumar - Frontend Designer & Developer - vk2code