diff --git a/.github/workflows/build-image.yml b/.github/workflows/cd.yml similarity index 93% rename from .github/workflows/build-image.yml rename to .github/workflows/cd.yml index bca4e134e..11cd4bbbe 100644 --- a/.github/workflows/build-image.yml +++ b/.github/workflows/cd.yml @@ -1,4 +1,4 @@ -name: Build Container Image +name: CD on: push: @@ -6,7 +6,7 @@ on: - master jobs: - build-image: + cd: runs-on: ubuntu-18.04 steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..ca527d7cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing Guide +이 글에서는 초기 개발 환경 세팅, 전반적인 workflow, branching 전략, commit convention 등을 다룹니다. + +## Initial Setup +가장 권장하는 개발환경은 vscode에서 지원하는 [development container](https://code.visualstudio.com/docs/remote/containers) 기능입니다. [Visual Studio Code(이하 vscode)](https://code.visualstudio.com/download), [Docker](https://docs.docker.com/engine/install/), [Docker Compose](https://docs.docker.com/compose/install/)가 설치되어있어야 합니다. + +1. vscode에 ['Remote - Containers'](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) 확장을 설치합니다. +2. clone한 repo를 vscode로 열고, `ctrl` + `shift` + `p`로 command palette를 열어 __"Remote-Containers: Reopen Folder in Container"__ 명령어를 검색하고 실행합니다. (우측 하단에 뜨는 팝업 창의 "Reopen in Container" 버튼을 눌러도 됩니다) +3. 컨테이너 이미지가 빌드되고 필요한 확장, 명령어 및 설정이 자동으로 구성됩니다. + +### Alternative: GitPod +위와 같은 개발 환경을 구성하기 어려운 경우, GitPod을 이용할 수 있습니다. 아래 버튼을 누르면 바로 시작할 수 있습니다. + +[![Open in GitPod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/skku-npc/skku-coding-platform) + +## Workflow +작성 예정 + +## Branching Starategy +작성 예정 + +## Commit Convention +작성 예정 diff --git a/README.md b/README.md index 9c7a624e9..780d1c306 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,36 @@ # SKKU Coding Platform -![issues](https://img.shields.io/github/issues/skku-npc/skku-coding-platform) -![docker](https://img.shields.io/docker/cloud/automated/skkunpc/coding-platform) -![checks](https://img.shields.io/github/checks-status/skku-npc/skku-coding-platform/master) -![python](https://img.shields.io/badge/Python-3.8.10-blue) -![django](https://img.shields.io/badge/Django-3.2.11-darkgreen) -![vue](https://img.shields.io/badge/Vue-2.6.11-green) +[![issues](https://img.shields.io/github/issues/skku-npc/skku-coding-platform)](https://github.com/skku-npc/skku-coding-platform/issues) +[![CD status](https://github.com/skku-npc/skku-coding-platform/actions/workflows/cd.yml/badge.svg)](https://github.com/skku-npc/skku-coding-platform/actions/workflows/cd.yml) +[![python](https://img.shields.io/badge/Python-3.8.10-blue)](https://www.python.org/) +[![django](https://img.shields.io/badge/Django-3.2.11-darkgreen)](https://www.djangoproject.com/) +[![vue](https://img.shields.io/badge/Vue-2.6.14-41b883)](https://vuejs.org/) [QingdaoU OJ](https://github.com/QingdaoU/OnlineJudge)를 기반으로 제작한 성균관대학교 Online Judge 시스템입니다. -## Installation ⚙ -Docker를 설치하고, docker compose를 실행합니다. +- 🐳 Docker 기반의 안전하고 빠른 배포 +- ✏ 다양한 언어 채점 지원(C/C++, Python, Java, Go) +- ⚡ SPA(Single Page Application) 기반의 빠르고 동적인 UI + +## How to Run ⚙ +[Docker](https://docs.docker.com/engine/install/)와 [docker-compose](https://docs.docker.com/compose/install/)를 설치하고, 다음 명령어를 실행합니다. ```shell -> git clone https://github.com/skku-npc/skku-coding-platform.git -> cd skku-coding-platform -> docker-compose up -d +curl https://raw.githubusercontent.com/skku-npc/skku-coding-platform/master/docker-compose.yml | docker-compose -f - up -d ``` 이후 [http://localhost](http://localhost)에 접속하면 페이지를 확인할 수 있습니다. 초기 admin 계정은 아이디 root, 비밀번호 rootroot 입니다. +## How to Contribute 👍 +[CONTRIBUTING.md](https://github.com/skku-npc/skku-coding-platform/blob/master/CONTRIBUTING.md)를 참고해주세요. + ## Documentation 📚 Wiki를 참고해주세요. https://github.com/skku-npc/skku-coding-platform/wiki +## Contributors 👏 + ### 운영진 박민서 [@minseo999](https://github.com/minseo999) 하솔비 [@SOLBI1028](https://github.com/SOLBI1028)