From 09a222385fbe3fc7b5bf41fe44ce742bfc47ecb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Geri=20M=C3=A1t=C3=A9?= Date: Thu, 5 Oct 2023 12:40:49 +0200 Subject: [PATCH] docs: update readme Update readme.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8b98ee9..97f7996 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,17 @@

-

Lightweight container manager.

+

Lightweight container manager.

+ +## Use cases + +- **SSH-less Container Monitoring:** You can add as many components of your infrastructure as you like, and check up on the services running in one place without SSH access. +- **Centralized View for Container Management:** One user-friendly interface to analyze logs and container configs, and interact with them. +- **Goodbye JSON (Hello UI):** Quickly interpretable UI to spare you from untangling data in JSON about your containers. ## Getting started -TODO: One liner `docker run` +Enter `docker run -p 8000:8000 -d ghcr.io/dyrector-io/darklens:latest` in terminal ## Development @@ -36,5 +42,5 @@ TODO: One liner `docker run` 1. Goto `web/backend` and run `npm start` 2. Goto `web/frontend` and run `npx prisma migrate dev` to apply migrations then start using `npm start` 3. The app will be available on `localhost:8000` - +
> Make sure the `dev-traefik` container is running as it routes the traffic between the frontend and the backend