Skip to content

Commit 3da8458

Browse files
authored
Feat/install instructions (#6)
* feat: installation instructions * feat: added pic
1 parent c3f6087 commit 3da8458

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Installing the GCS Repo
3+
description: Updated as of 09/17/25
4+
sidebar:
5+
order: 1
6+
---
7+
8+
## Quick Start Guide
9+
This instructions are meant for users who are familiar with the repo and just need a quick refresher on how to install it. For more detailed instructions, please refer to the Detailed Instructions section below.
10+
> Note: If the map server fails to render properly (white screen), please refer to the Map Server Debugging Notes section below.
11+
12+
### List of Commands needed to run in order (starting from `bun install` and ending at `bun tauri`)
13+
```bash
14+
bun install
15+
bun run osm:setup
16+
bun run osm:run
17+
docker-compose up db
18+
docker-compose up rabbitmq
19+
bun tauri
20+
```
21+
22+
---
23+
24+
25+
## Detailed Instructions
26+
1. Clone the repo
27+
2. Install the Frontend dependencies using bun (ideal package manager but npm also works)
28+
```bash
29+
bun install
30+
```
31+
3. Run the osm-setup command first before initializing all Docker Images(use the package.json script with `bun osm:setup` and not `docker-compose up` to avoid running all containers)
32+
```bash
33+
bun run osm:setup
34+
```
35+
36+
4. The osm-setup command IS SUPPOSED TO TAKE A WHILE TO INSTALL. If it isn't, please end the process and try again.
37+
38+
<img width="1902" height="1436" alt="image" src="https://github.com/user-attachments/assets/ade11f07-2366-4af7-aa74-a0ee21c75bec" />
39+
40+
41+
42+
6. After the setup is complete, run the PostGreSQL and RabbitMQ containers using docker-compose
43+
```bash
44+
docker-compose up db
45+
docker-compose up rabbitmq
46+
```
47+
> Note: You can use the VSCode Containers extension (equivalent to Docker Desktop) to manage the containers if you don't have Docker Desktop installed. But you still need to have Docker installed on your machine.
48+
> To use the VSCode Containers extension, open the `docker-compose.yml` file in VSCode and click on the "Run Service" button above all services EXCEPT THE OSM-SETUP SERVICE.
49+
50+
6. IMPORTANT NOTE: Please do not run `docker-compose up` as it will run all containers and cause the map server to fail. Follow the steps above to ensure proper installation.
51+
52+
7. To run the entire GCS application, ensure that the osm-server, PostGreSQL, and RabbitMQ containers are running. Run the application using:
53+
```bash
54+
bun tauri
55+
```
56+
57+
58+
## Map Server Debugging Notes
59+
- If you get an error "Error: role renderer already exists" when running the map server, go into Docker Desktop and delete the volume installed. Re-run the setup command to install the volume again.
60+
- Possible solution to making sure that the map server renders properly:
61+
- Stop all containers
62+
- Delete ALL volumes, containers, and images related to GCS in Docker Desktop
63+
- Re-run the setup command
64+
- Start the PostGreSQL and RabbitMQ containers only
65+
- Run the map server using `bun tauri`
66+
- There is a difference between running the osm:setup script vs the docker-compose up osm-setup. In the underlying code for osm:setup, it is docker-compose run while docker-compose up runs all containers. This is why it is important to run the setup script and not the docker-compose command.

0 commit comments

Comments
 (0)