---
title: Niyam API
emoji: 🦀
colorFrom: blue
colorTo: pink
sdk: docker
pinned: false
---

# niyamAPI

System for the Niyam project.
https://axyut-niyam-api.hf.space/docs

# Setup

## env setup

```bash
cp example.env .env
```

then edit `.env` with required variables

## run with go

```bash
go run .
```

## run with air

```bash
air
```

if you do not have air, install with, `go install github.com/air-verse/air@latest`

## with docker

```bash
docker compose up --build
```