From fda7be1d7ae4b93e3538eef09283e67ac5d44126 Mon Sep 17 00:00:00 2001
From: mohammadreza javid <mohammadrezajavid60@gmail.com>
Date: Fri, 20 Mar 2026 13:51:12 +0330
Subject: [PATCH] update readme niki project

---
 README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..135eaefc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# Niki
+
+---
+
+## Prerequisites
+
+- **Go 1.25.4** (Ensure your Go version matches this requirement)
+- **Docker 20.10+** (or higher)
+- **Git**
+
+---
+
+## Installation
+
+### 1. Configure Go Module Mirror
+
+To accelerate dependency downloads, set the Go module mirror to **Megan** (Iranian Go mirror):
+
+```url
+https://megan.ir/hub/go
+```
+
+### 2. Install Dependencies
+
+```bash
+go mod tidy
+go mod vendor
+```
+
+### 3. Configure Environment
+
+Copy the example environment file and customize it:
+
+```bash
+cp .env.example .env
+```
+
+---
+
+## Running the Application
+
+### 1. Start Services
+
+Launch the database and Redis services using Docker Compose:
+
+```bash
+docker compose up -d
+```
+
+> 🌐 *Docker images are sourced from [Arvan Cloud's Docker repositories](https://www.arvancloud.ir/fa/dev/docker). Ensure
+your environment has access to these repositories.*
+
+### 2. Apply Database Migrations
+
+Initialize the database schema:
+
+```bash
+go run main.go --migrate
+```
+
+### 3. Start the Application
+
+Run the application in development mode:
+
+```bash
+go run main.go
+```
+
+> ✨ **Alternative**: Use the provided `Makefile` for streamlined execution:
+> [Makefile](Makefile)