Installation

*Table of Contents:

• Installing TreeMap
• Running a development setup

Installing TreeMap

The recommended way for now is to use Docker. You need to install it on your machine, then use this command to run the server:

$ docker run -p 8000:8000 -v $PWD/var:/app/var ghcr.io/umonkey/treemap:latest

This will make the app available at localhost:8000, with the SQLite database stored in ./var. The application can be configured using environment variables, see the configuration page for details.

Note that the app is not yet ready for production, as it lacks user authentication and a lot more.

Running a development setup

For development, you need to install Rust and Node on your machine, then run backend and frontend separately.

To run the backend, use this command:

$ make -C backend serve

To run the front end, use this command:

$ make -C frontend serve