Nest M.U.D - Getting Started

• Getting Started
• How to Play
• API
• Design

A M.U.D (multi user dungeon) with a back end API built with nestjs and a front end UI built with Flutter.

❗ Project Complete ~ October 3rd 2021 ❗

Only a small subset of features has been implemented to demonstrate as a proof of concept.

Follow the next iteration in the Go M.U.D repository.

Server

📝 Look at what these scripts actually do before running them!

Setup

Attempts to install nvm, node, yarn, nestjs and package.json defined dependencies.

cd server
./script/setup

Start Server

Starts a postgres database in a docker container, runs database migrations with db-migrate, loads game data and starts the nestsjs API server.

cd server
./script/start

Start Client

Generate client configuration code.

cd client
./script/start

Use your favourite Flutter project IDE and Android/iOS emulator.

Special Note

As I would much prefer to build the backend in Go, I chose to build limited funtionality into this version as a proof of concept and a means of learning something about nestjs and TypeScript.