## 개발 관련

### Figma 페이지
> 페이지 읽기 권한이 없으면 젠틀파파스에 권한 요청해야 함

**최초 시안**
https://www.figma.com/design/1aAwk6K7WlmAWcQlIhI5XN/UGQ?node-id=0-1&t=KIXkUCQi3z8nRoEt-0

**운영툴 시안**
https://www.figma.com/design/tgKFPusj3kc7XUFom3wSQ5/%EC%B9%BC%EB%A6%AC%EB%B2%84%EC%8A%A4_all?t=p9bpWkspzN01pM2a-0




### 서버 실행 인자
```
UGQApiServer 0.0.0.0
Copyright (C) 2024 author

  -t, --serverType    Required. UGQ API Server Type: [UgqApi, UgqAdmin, UgqIngame, UgqAllInOne]

  -p, --port          Required. UGQ API Server Port

  -d, --develop       (Default: false) UGQ API Server Development Mode
```

#### 서버 타입
UgqApi
- 웹 프론트에서 호출되는 api

UgqAdmin
- 웹 어드민에서 호출되는 api

UgqIngame
- 메타버스 서버에서 호출되는 api

UgqAllInOne
- UgqApi, UgqAdmin, UgqIngame을 모두 포함

#### 개발 모드
개발 편의를 위해 개발된 api로 Debug 빌드에만 포함되어 있음

아래 페이지에서 개발 api 확인및 호출 가능
http://localhost:11000/swagger/index.html?urls.primaryName=Development


### FakeDataScript
테스트 데이터를 생성하는 Python 스크립트

**경로**
Caliverse\\Server\\CaliServer\\UGQDatabase\\FakeDataScript


**더미 데이터 생성**
```
python ./insert_fake_data.py
```

**입력한 계정에 미리 json으로 작성된 퀘스트를 추가**
```
python .\insert_quest.py --env=local --login_id=spooky000 --folder=sample1
python .\insert_quest.py --env=aws --login_id=spooky000 --folder=sample1
```



## AWS Dev 서버 세팅
젠틀파파스, 기획팀등 UGQ 개발 시 모두 이 서버에 접속해서 테스트 하고 있음

### 서버 업데이트 방법

1. WinSCP 사용해서 서버 복사
	Caliverse\\Server\\bin\\Debug를 ~/UGQApiServer로 복사 (logs, support 폴더 제외하고)

2. MS5-Dev-UGQAPI 서버에 접속

3. 재시작 명령어 실행
	sudo systemctl restart UGQAPIServer.service

4. 서버가 잘 실행되고 있는지 상태확인
	sudo systemctl status UGQAPIServer.service

5. 로그 확인
	~/UGQApiServer/logs/dotnet.json

### Dev 웹사이트
```

# 구글 계정으로 로그인해서 UGQ 테스트
https://dev.workshop.caliverse.io/en

# UGQApiServer의 swagger 페이지
https://dev-ugqapi.caliverse.io:11000/swagger/index.html
```


### AWS Dev 설정
Caliverse\Server\CaliServer\UGQApiServer\appsettings.AWSDev.json
	MongoDB는 AWS에 세팅된 서버
	DynamoDB, Redis는 사내 서버 (10.20.20.8) 에 접속하도록 설정되어 있음
	이 설정은 Caliverse\\Server\\Configs\\Default\\UGQApiServer-Dev.json 파일과 같음

### UGQ MongoDB migration
MongoDB index 생성, 삭제등을 실행하는 명령어가 있음

**경로**
Caliverse\\Server\\CaliServer\\UGQDatabase\\mongodb-migration

**실행 방법**
```
cd Caliverse\Server\CaliServer\UGQDatabase\mongodb-migration
pip install -r requirements.txt
python -m doit migrate --env=xxxx
```

### Stage, Live 설정
기존 메타버스 서버와 같은 구조에 맞춰져 있임

**경로**
Caliverse\\Server\\Configs\\Default

**nlog 설정**
- nlog-UGQApiServer.config

**UGQApiServer 설정**
- UGQApiServer-Dev.json
- UGQApiServer-Live.json
- UGQApiServer-Stage.json