CMU Maps

Overview

CMU Maps is a web application that provides a map of the CMU campus, allowing users to easily access information about campus locations. Key features include:

• View floorplans
• Room level navigation
• Search for buildings and rooms
• View building and room details

Wiki

Visit the wiki for more information about the project.

Getting Started

Permission Prerequisite

Follow the instructions in governance/README.md to obtain the necessary permissions.

Dev Container Setup

Prerequisites: Docker and Dev Containers Extension.

1. Clone and open the repository locally in VS Code (or any other IDE that supports Dev Containers).
2. Click on the Reopen in Container button that pops up in the bottom left corner of the VS Code window.
   • Or open the command palette and run the command Dev Containers: Reopen in Container.
3. Wait for the container to start. It may take a few minutes to install dependencies and run post create script.
4. Visit the respective README files to start developing!
   • Web: apps/web/README.md
   • Visualizer: apps/visualizer/README.md
   • Server: apps/server/README.md
   • Data: apps/data/README.md
   • Scripts: scripts/README.md

Troubleshooting

Dev Container Installation Issues

Check if the Docker Desktop version is up to date.

Post Create Script

If the post create command in dev container fails, you can manually run the post create script in the container by running the following command in the root directory:

./scripts/post-create.sh

Manual Setup

If you just can't get the dev container setup to work, try the manual setup instructions (not recommended).

Biome Formatter

If you are not able to use Biome as a formatter, you can try resintalling the extension.