Local Installation

1. Create a root folder for your project (e.g. 'maxun')
2. Create a file named .env in the root folder of the project
3. Example env file can be viewed here. Copy all content of example env to your .env file.
4. Choose your installation method below

Docker Compose

1. Copy paste the docker-compose.yml file into your root folder
2. Ensure you have setup the .env file in that same folder
3. Run the command below from a terminal

docker-compose up -d

You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/

Without Docker

1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.
2. Run the commands below

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

# 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 ..

# install chromium and its dependencies
npx playwright install --with-deps chromium

# get back to the root directory
cd ..

# start frontend and backend together
npm run start

You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/

Environment Variables

1. Create a file named .env in the root folder of the project
2. Example env file can be viewed here.