__
api__
Overview
Waldreg는 동아리를 관리하는데 특화된 서비스로, 동아리를 운영하며 필요하다고 생각한 기능인 구성원의 출석 여부 확인 기능, 내부 데이터를 저장하는 기능
, 역할 기반 구성원의 접근 가능 정보 지정 기능 구성원들의 가중치를 기반으로 팀을 맺어주는 기능... 등이 한곳에 모인 프로그램을 찾을 수 없어서 개발을 하게 되었습니다.
Waldreg 를 사용하면 다음과 같은 서비스를 통해 동아리를 효과적으로 관리할 수 있습니다.
- 출석 시스템을 이용해 동아리에 참석한 동아리원을 판별할 수 있습니다.
- 상 벌점 시스템을 이용해 동아리원의 기여도를 측정할 수 있습니다.
- 일정 관리 시스템을 이용해 동아리의 전체적인 일정을 관리 할 수 있습니다.
- 구성원들의 가중치를 기반으로 자동으로 팀을 만드는 기능을 이용해 팀 구성을 자동화 할 수 있습니다.
- 구성원들에게 역할을 주어 접근가능한 정보를 조절할 수 있습니다.
- 저장소와 게시판 기능을 이용해 동아리 내부 데이터를 보관할 수 있습니다.
Getting start
Waldreg 는 Docker를 이용해서 배포되고 있으며, 이 문서는 Docker를 이용해 waldreg 애플리케이션을 각자의 서버에 세팅해 구동하는 방법을 설명합니다.
Download api server
- 이 레포지토리를 클론합니다.
git clone https://github.com/waldreg/waldreg-api.git- Dockerfile이 위치한 폴더로 이동합니다.
cd waldreg-api- 서버를 구동하기 위해 Dockerfile 과 같은 경로에 위치한 .env파일을 편집합니다.
.env 파일은 다음과 같습니다.
DB_ROOT_PASSWORD=${db root 유저의 password}
DB_PASSWORD=${db waldreg 유저의 password}
DB_URL=jdbc:... # 수정금지
DDL_AUTO_RULE=update # 만약, DDL생성 기능을 정의합니다. 이미 table을 생성한경우, 혹은 운영환경인경우 none으로 설정하세요- .env 파일 편집을 마쳤다면, 다음 명령어를 입력해 애플리케이션을 실행합니다.
docker-compose up