From 10b0cf6117c0a10aeec103b5b8f6be625a43dda7 Mon Sep 17 00:00:00 2001 From: SungWoongz Date: Tue, 25 Jun 2024 14:22:42 +0900 Subject: [PATCH] Update README.md --- README.md | 74 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 51 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e08f6d30..c34b85c2 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,67 @@ -# Welcome to Buffalo +**[설치 환경]** -Thank you for choosing Buffalo for your web development needs. -## Database Setup +mc-web-console은 1.19 이상의 Go 버전이 설치된 다양한 환경에서 실행 가능하지만 최종 동작을 검증한 OS는 Ubuntu 22.0.4입니다. -It looks like you chose to set up your application using a database! Fantastic! +**[의존성]** -The first thing you need to do is open up the "database.yml" file and edit it to use the correct usernames, passwords, hosts, etc... that are appropriate for your environment. +mc-web-console은 내부적으로 mc-iam-manager & mc-infra-manager의 개방형 API를 이용하기 때문에 각 서버의 연동이 필요합니다.(필수) -You will also need to make sure that **you** start/install the database of your choice. Buffalo **won't** install and start it for you. +- https://github.com/m-cmp/mc-infra-manager README 참고하여 설치 및 실행 +- https://github.com/m-cmp/mc-iam-manager README 참고하여 설치 및 실행 (검증된 버전 : mc-iam-manager v0.2.0). -### Create Your Databases +--- -Ok, so you've edited the "database.yml" file and started your database, now Buffalo can create the databases in that file for you: +**[소스 설치]** -```console -buffalo pop create -a -``` +- Git 설치 + - `$ sudo apt update` + - `$ sudo apt install git` -## Starting the Application +- Go 1.19 이상의 버전 설치 ( 공식 문서 참고 ) + - https://go.dev/doc/install -Buffalo ships with a command that will watch your application and automatically rebuild the Go binary and any assets for you. To do that run the "buffalo dev" command: +- mc-web-console 설치 + + ```bash + $ git clone https://github.com/m-cmp/mc-web-console.git + ``` + + ```bash + $ git clone https://github.com/m-cmp/mc-web-console.git + ``` + + - web_console_api + + ```bash + $ cd mc-web-console/mc_web_console_api + $ buffalo build + ``` + + - web_console_front + + ```bash + $ cd mc-web-console/mc_web_console_front + $ npm install + $ yarn install + $ buffalo build + ``` + -```console -buffalo dev -``` +--- -If you point your browser to [http://127.0.0.1:3000](http://127.0.0.1:3000) you should see a "Welcome to Buffalo!" page. +**[환경 설정]** -**Congratulations!** You now have your Buffalo application up and running. +- ./.env 파일에서 이용하고자 하는 개방형 API 서버의 실제 URL 정보로 수정합니다. + + **[주의사항]** + + mc-web-console을 비롯하여 연동되는 모든 서버가 자신의 로컬 환경에서 개발되는 경우를 제외하고는 클라이언트의 웹브라우저에서 접근하기 때문에 localhost나 127.0.0.1 주소가 아닌 실제 IP 주소를 사용해야 합니다. + -## What Next? +--- -We recommend you heading over to [http://gobuffalo.io](http://gobuffalo.io) and reviewing all of the great documentation there. +**[mc-web-console 실행]** -Good luck! - -[Powered by Buffalo](http://gobuffalo.io) +- 코드기반 실행 + - `$ ./startDev.sh` / `$ ./stopDev.sh` 활용