Local Setup

This guide will help you install and run Maxun on your local system.

Prerequisites

Software	Download Link
Node.js (18 or above)	Download Node.js
PostgreSQL	Download PostgreSQL
MinIO	Download MinIO

Installation Steps

1. Clone the repository

git clone https://github.com/getmaxun/maxun

2. Create a .env file in the project root folder (maxun in this case)
3. Copy the content from the example env file to your .env
4. Ensure you have the prerequisites installed on your system.
5. Install dependencies

# change directory to the project root
cd maxun

# install dependencies
npm install

# change directory to maxun-core to install dependencies
cd maxun-core 
npm install

# get back to the root directory
cd ..

5. Install Playwright

# make sure playwright is properly initialized
npx playwright install
npx playwright install-deps

# get back to the root directory
cd ..

6. Run the command below in the root directory of the project

# start frontend and backend together
npm run start

You can access the frontend at PUBLIC_URL (eg: http://localhost:5173/) and backend at BACKEND_URL (eg: http://localhost:8080/)

To set the PUBLIC_URL & BACKEND_URL environment variables, refer Environment Variables section.