Local Development

Malak runs with very minimal hardware requirements by itself. While it

Malak has been tested and developed extensively on macOS but there are extremely high chances it works and compiles correcly on windows. Let us know if it does :)

For production, we strongly recommend Linux

To run Malak, you need to install a few things. Go, Node.js, bun, Git. We will not go through the installation of these as you can find them on their relative websites.

Development Setup

Step 1: Clone the Malak Repo

  git clone [email protected]:ayinke-llc/malak.git

Backend

Navigate to the newly created malak directory

docker compose up

This installs the dependencies you need: Postgresql, Redis, Minio, Grafana and Mailhog for local email testing

Configuration

At the very minimum, you need to create a config.yml containing the following:

auth:
  google:
    client_id: "CLIENT_ID"
    client_secret: "CLIENT_SECRET"
    redirect_uri: "http://localhost:3000"
    is_enabled: true

  jwt:
    key: JWT_KEY

billing:
  default_plan_reference: prod_Qmjfkf

http:
  port: 5300 ## defaults to 5300
  swagger:
    port: 9999
    ui_enabled: true

uploader:
  s3:
    access_key: BhK
    access_secret: dzE
    region: lagos-1
    endpoint: http://localhost:9000
    use_tls: false

email:
  provider: smtp
  sender: [email protected]
  sender_name: Malak
  resend:
    api_key: fjfk
    webhook_secret: fufhifuji

secrets:
  provider: aes_gcm
  aes:
    key: ujffjkfk

api_key:
  hash_secret: 123459yu7teguifg7894tg8947ty

You can find all possible configuration values here

Running binary

Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn’t align with the production version, please update the CLI:

  task run:http

  go run cmd/*.go

Frontend

Install dependencies

  cd web/ui

  bun i

Add configuration

This should go to your .env or .env.local file

NEXT_PUBLIC_GOOGLE_CLIENT_ID=
# NEXT_PUBLIC_MALAK_POSTHOG_KEY=
# NEXT_PUBLIC_MALAK_POSTHOG_HOST=https://us.i.posthog.com
# NEXT_PUBLIC_MALAK_ENABLE_POSTHOG=false
# NEXT_PUBLIC_SENTRY_DSN=https://xxxx.ingest.us.sentry.io/45
NEXT_PUBLIC_DECKS_DOMAIN=https://deck.malak.vc
[email protected]
NEXT_PUBLIC_APP_URL=http://localhost:3000
NEXT_PUBLIC_API_URL=http://localhost:5300/v1

Open Source Contributions

Self Hosting

One click deployments

Changelog

Development Setup

Backend

Configuration

Running binary

Frontend

Install dependencies

Add configuration

​Development Setup

​Backend

​Configuration

​Running binary

​Frontend

​Install dependencies

​Add configuration

Development Setup

Backend

Configuration

Running binary

Frontend

Install dependencies

Add configuration