From 643946e4426196374094cfafb474377a3e85ca5b Mon Sep 17 00:00:00 2001 From: Aisuko Date: Sun, 28 Jul 2024 10:47:12 +1000 Subject: [PATCH] Add doc (#328) Signed-off-by: Aisuko --- README.md | 10 +++++++--- docs/Requirements.md | 11 +++++++++++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a473008..13ada97 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ [![Linter and Builder 🚀](https://github.com/SkywardAI/chat-backend/actions/workflows/linter-and-builder.yaml/badge.svg)](https://github.com/SkywardAI/chat-backend/actions/workflows/linter-and-builder.yaml) [![Release Drafter 🚀](https://github.com/SkywardAI/chat-backend/actions/workflows/release-drafter.yml/badge.svg)](https://github.com/SkywardAI/chat-backend/actions/workflows/release-drafter.yml) [![Releasing Image 🚀](https://github.com/SkywardAI/kirin/actions/workflows/release-image.yaml/badge.svg)](https://github.com/SkywardAI/kirin/actions/workflows/release-image.yaml) [![CodeQL](https://github.com/SkywardAI/kirin/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/SkywardAI/kirin/actions/workflows/github-code-scanning/codeql) +>[!Warning] +>**Kirin is currently in Development**: Expect breaking changes and bugs! + + # Architecture ![](./imgs/SkywardAI(Mind%20Map)%20-%20APIs%20aggregator.svg) @@ -38,6 +42,8 @@ You need to make sure Docker and docker-compose on your environment. See [Requir If you want to setup the project quickly, please follow the steps below: +Please check the [Requirements.md](./docs/Requirements.md) to prepare you env + ``` git clone https://github.com/SkywardAI/kirin.git @@ -46,8 +52,6 @@ cd kirin make demo ``` -See [quick start](https://skywardai.github.io/skywardai.io/docs/quick-start.html) - # Build and deployment @@ -55,7 +59,7 @@ See [quick start](https://skywardai.github.io/skywardai.io/docs/quick-start.html [![Build and Deployment](https://img.youtube.com/vi/63OxSmcBkhI/0.jpg)](https://youtu.be/63OxSmcBkhI?si=G82BOtcwRvQE7dLU) -Also See [deployment](https://skywardai.github.io/skywardai.io/docs/development/build_and_run.html). And if you are interested in docker-in-docker development, see [Development.md](./docs/Development.md) +And if you are interested in docker-in-docker development, see [Development.md](./docs/Development.md) # Tech stack diff --git a/docs/Requirements.md b/docs/Requirements.md index 6b157da..bdf526b 100644 --- a/docs/Requirements.md +++ b/docs/Requirements.md @@ -44,3 +44,14 @@ ubuntu:~/workspace/aisuko/kirin$ docker compose version Docker Compose version 2.24.6+ds1-0ubuntu1~22.04.1 ``` +## Rootless docker + +``` +ec2-user@ip-10-110-144-85:~/workspace/kirin$ sudo usermod -aG docker $USER +ec2-user@ip-10-110-144-85:~/workspace/kirin$ newgrp docker + +ec2-user@ip-10-110-144-85:~/workspace/kirin$ docker ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +``` + +And you are good to go. \ No newline at end of file