Getting Started

Get up and running with Mantiks in under 5 minutes.

Prerequisites

Before you begin, make sure you have the following software installed on your machine:

curl

Latest

Install →

Required to download mise

git

Latest

Install →

Version control system for cloning the repository

unzip

Latest

Bootstrap uses it to extract Google Cloud SDK

xz-utils

Latest

Bootstrap uses it to extract PostgreSQL (.tar.xz format)

Installation

Follow these steps to set up your development environment:

1

Clone the repository

Clone the Mantiks starter kit to your local machine.

$ git clone git@github.com:maxkoretskyi/mantiks.git && cd mantiks
2

Install mise

We use mise to keep the setup local without polluting your system with global installations.

$ curl https://mise.run | sh
3

Add mise to PATH

Add mise to your PATH for the current session (or add to ~/.bashrc to persist).

$ export PATH="$HOME/.local/bin:$PATH"
4

Activate mise and install tools

Trust the project config, activate mise, and install Node.js and pnpm.

$ mise trust && eval "$(mise activate bash)" && mise install
5

Run bootstrap

Downloads PostgreSQL and Google Cloud SDK, initializes the database, and installs dependencies.

$ ./scripts/bootstrap
6

Configure environment

Copy the example environment file and add any required secrets.

$ cp .env.example .env
7

Start the database

Start the local PostgreSQL database.

$ ./scripts/db-start
8

Start the development server

Run all apps in development mode.

$ pnpm dev

You're all set!

Your apps are now running:

localhost:3300 (Client) localhost:3301 (Auth) localhost:8800 (API)

Need help?

Join our free workshop to get hands-on guidance from the creator of Mantiks.

View upcoming workshops