From b8083215b3b4fa394073135b4a7281c20a0dac08 Mon Sep 17 00:00:00 2001 From: Cesar N Date: Wed, 19 Apr 2023 11:12:21 -0700 Subject: [PATCH] Update Dev Docs with MinIO naming conventions (#2783) --- DEVELOPMENT.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 72c9c60b1..702943812 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,25 +1,24 @@ -# Developing Console +# Developing MinIO Console -Console requires to have the [MinIO](https://github.com/minio/minio) server, Console server and the Console web app running. +The MinIO Console requires the [MinIO Server](https://github.com/minio/minio). For development purposes, you also need to run both the MinIO Console web app and the MinIO Console server. -## Running Server +## Running MinIO Console server Build the server in the main folder by running: ``` make ``` > Note: If it's the first time running the server, you might need to run `go mod tidy` to ensure you have all modules required. - To start the server run: ``` CONSOLE_ACCESS_KEY= CONSOLE_SECRET_KEY= -CONSOLE_MINIO_SERVER= +CONSOLE_MINIO_SERVER= CONSOLE_DEV_MODE=on ./console server ``` -## Running Web app +## Running MinIO Console web app Refer to `/portal-ui` [instructions](/portal-ui/README.md) to run the web app locally.