Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Get Started

Cloud

Self-hosting requires more technical skill to setup instance, backing up database and maintaning updates. If you aren't experienced at managing servers and just want to use the webapp, we recommend using aimicromindCloud.

Quick Start

{% hint style="info" %} Pre-requisite: ensure NodeJS is installed on machine. Node v18.15.0 or v20 and above is supported. {% endhint %}

Install aimicromind locally using NPM.

  1. Install AiMicromind:
npm install -g aimicromind

You can also install a specific version. Refer to available versions.

npm install -g aimicromind@x.x.x
  1. Start AiMicromind:
npx aimicromind start
  1. Open: http://localhost:3000

Docker

There are two ways to deploy aimicromind with Docker:

Docker Compose

  1. Go to docker folder at the root of the project
  2. Copy the .env.example file and paste it as another file named .env
  3. Run:
docker compose up -d
  1. Open: http://localhost:3000
  2. You can bring the containers down by running:
docker compose stop

Docker Image

  1. Build the image:
docker build --no-cache -t aimicromind.
  1. Run image:
docker run -d --name aimicromind-p 3000:3000 aimicromind
  1. Stop image:
docker stop aimicromind

For Developers

AiMicromind has 3 different modules in a single mono repository:

  • Server: Node backend to serve API logics
  • UI: React frontend
  • Components: Integration components

Prerequisite

Install PNPM.

npm i -g pnpm

Setup 1

Simple setup using PNPM:

  1. Clone the repository
git clone https://github.com/operativestech/AiMicroMind_Platform_2025.git
  1. Go into repository folder
cd AiMicromind
  1. Install all dependencies of all modules:
pnpm install
  1. Build the code:
pnpm build

Start the app at http://localhost:3000

pnpm start

Setup 2

Step-by-step setup for project contributors:

  1. Fork the official AiMicromind Github Repository
  2. Clone your forked repository
  3. Create a new branch, see guide. Naming conventions:
    • For feature branch: feature/<Your New Feature>
    • For bug fix branch: bugfix/<Your New Bugfix>.
  4. Switch to the branch you just created
  5. Go into repository folder:
cd AiMicromind
  1. Install all dependencies of all modules:
pnpm install
  1. Build the code:
pnpm build
  1. Start the app at http://localhost:3000
pnpm start
  1. For development build:
  • Create .env file and specify the PORT (refer to .env.example) in packages/ui
  • Create .env file and specify the PORT (refer to .env.example) in packages/server
pnpm dev

  • Any changes made in packages/ui or packages/server will be reflected at http://localhost:8080

  • For changes made in packages/components, you will need to build again to pickup the changes

  • After making all the changes, run:

    pnpm build

    and

    pnpm start

    to make sure everything works fine in production.

For Enterprise

Enterprise plans have separate repository and docker image.

Once granted access to both, the setup is the same as #setup-1. Before starting the app, enterprise users are required to fill in the values for Enterprise Parameters in the .env file. Refer to .env.example for the required changes.

Reach out to support@aimicromind.com for the value of following env variables:

LICENSE_URL
AIMICROMIND_EE_LICENSE_KEY

For Docker Installation:

cd docker
cd enterprise
docker compose up -d

Learn More

In this video tutorial (coming soon)

Community Guide