moor

(β˜… 217)

A system for building shared, programmable, online spaces. Compatible with LambdaMOO. Built for the future.

File Explorer

Download Latest Version (.zip)
  • .dockerignore
  • .envrc
  • .gitignore
  • .licensure.yml
  • AGENTS.md
  • bacon.toml
  • Cargo.lock
  • Cargo.toml
  • ChangeLog.md
  • CLA.md
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • Dockerfile.arm64-cross
  • Dockerfile.elle
  • dprint.json
  • flake.lock
  • flake.nix
  • LICENSE
  • moor-dev.yaml
  • package-lock.json
  • package.json
  • process-compose-dev.yaml
  • process-compose.yaml
  • README.md
  • single-process-deployment.md
  • TLDR-mooR.md

# Installation Guide

1. Get the code
git clone https://github.com/timbran-project/moor

Downloads the entire project code from GitHub to your computer.

cd moor

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f deploy/clustered/docker-compose.tcp.yml up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd clients/meadow_flutter/linux

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd clients/meadow_flutter/android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm run full:dev

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r tools/example-python-worker/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

7. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

8. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd cores/benches

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

PowerToys β˜… 137,936

Microsoft PowerToys is a collection of utilities that supercharge productivity and customi

C
rustdesk β˜… 121,416

An open-source remote desktop application designed for self-hosting, as an alternative to

Rust
transformers β˜… 164,305

πŸ€— Transformers: the model-definition framework for state-of-the-art machine learning model

Python
javascript-algorithms β˜… 196,529

πŸ“ Algorithms and data structures implemented in JavaScript with explanations and links to

JavaScript
syncthing β˜… 87,847

Open Source Continuous File Synchronization

Go
HowToCook β˜… 101,850

Programmer's guide about how to cook at home.
// repository documentation