Merge pull request #34 from sparcs-kaist/develop

Add better project explanations

.gitignore

@@ -18,3 +18,6 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# Custom
+/.vscode

.prettierrc

@@ -0,0 +1,4 @@
+{
+    "singleQuote": false,
+    "trailingComma": "all"
+}

docs/projects.md

@@ -4,4 +4,4 @@ import DocCardList from '@theme/DocCardList';
 
 SPARCS에서 진행하는 프로젝트입니다.
 
-<DocCardList />
+<DocCardList className="DocCardList--no-description" />

docs/projects/ara.md

@@ -1,62 +1,66 @@
-# Ara
+import ProjectLogo from '@site/src/components/ProjectLogo';
 
-<a href="https://newara.sparcs.org/">
-  <img src="/projects/ara/logo.svg" width="400" />
-</a>
+# Ara
 
-Ara, KAIST's official community service
+<ProjectLogo
+    name="Ara"
+    url="https://ara.kaist.ac.kr"
+    catchphrase="Ara, KAIST's official community service"
+/>
 
-## History
+## 역사
 
-Ara는 SPARCS가 창립된 해인 1991년부터 **_SPARCS BBS_** 라는 이름으로 사용된 서비스입니다. 당시 Ara는 Eagle
-BBS(Bulletin Board System) 기반으로 개발되었으며 대한민국에서 두 번째로 인터넷에 연결된 BBS 서비스입니다. 현존하는
-BBS 서비스 중 가장 오래되었습니다.
+**_Ara_**는 SPARCS가 창립된 해인 1991년부터 **_SPARCS BBS_** 라는 이름으로 사용된 서비스입니다. 당시 Ara는 Eagle
+BBS(Bulletin Board System) 기반으로 개발되었으며 대한민국에서 두 번째로 인터넷에 연결된 BBS 서비스입니다. 이는 현존하는
+BBS 서비스 중 가장 오래된 서비스입니다.
 
-1998년, newsgroup을 연동하고자 한 NNTP(Network News Transfer Protocol) 기반의 **_NeoAra_**
-가 론칭되었습니다. KAIST 구성원뿐만 아니라 KAIST 주변의 국내 인터넷 사용자 모두를 위한 newsgroup의 역할을 하고자 하였습니다.
+1998년 공개된 **_NeoAra_**는 newsgroup을 연동하기 위한 NNTP(Network News Transfer Protocol) 기반으로 개발되었습니다. 이를 통해 KAIST 구성원뿐만 아니라 KAIST 주변의 국내 인터넷 사용자 모두를 위한 newsgroup의 역할을 하고자 하였습니다.
 
-2006년에 론칭된 **_NeoAra & WebAra_** 부터 웹과의 연동이 가능해졌습니다. 덕분에 Telnet과 NNTP에 더해 Web으로도
-Ara를 이용할 수 있게 되었습니다. 또한 파일 첨부 기능이 추가되었습니다.
+2006년 공개된 **_NeoAra & WebAra_** 이후부터 웹과 연동할 수 있었습니다. 이를 통해 Telnet, NNTP 뿐만 아니라 Web으로도
+Ara를 이용할 수 있게 되었으며 파일 첨부 기능이 추가되었습니다.
 
 NeoAra & WebAra의 유지 보수가 어려워짐에 따라 이종 언어가 자유로이 쓰일 수 있는 확장 구조의 **_Arara 1세대_** 가
 개발되었습니다. Python을 기반으로 백엔드는 SQLAlchemy, 미들웨어는 Thrift RPC, 프론트엔드는 Django Template
 Engine을 사용하였습니다.
 
-Arara 1세대를 리뉴얼한 **_Arara 2세대_** 는 2010년부터 2020년 10월까지 가장 오래 이용된 Ara입니다. 리뉴얼 당시
+Arara 1세대를 재단장한 **_Arara 2세대_** 는 2010년부터 2020년 10월까지 가장 오래 이용된 Ara입니다. 재단장 당시
 동시 접속자 수 200명, 하루 평균 접속자 수 7,000명으로 KAIST 공식 커뮤니티로서의 위상을 확인할 수 있었습니다. 기존 엔진의
 디자인을 새롭게 하고 XpressEngine 기반의 Ara를 개발하려는 노력이 있었습니다. RSS(Really Simple Syndication)
 등 사용자의 편의를 위한 기능이 구현되었습니다.
 
-Ara를 모바일로 이용하는 사용자가 증가함에 따라 디자인과 엔진 성능을 개선하고자 한 **_Mobile Ara_** 가 개발되었습니다.
+Ara를 모바일로 이용하는 사용자가 증가함에 따라 디자인과 엔진 성능을 개선하고자 **_Mobile Ara_** 가 개발되었습니다.
 
 SPARCS 내 Git 사용 정착에 기여한 **_Arari_**, 서울에서 소규모로 진행된 Ara 리뉴얼 프로젝트인 **_Ara2_** 개발이
-진행되었지만 론칭되지는 못하였습니다.
+진행되었지만 정식으로 공개되지 못하였습니다.
 
 **_Ara Plus_** 는 Ara 활성화를 위해 커뮤니티 활동을 즐길 수 있는 풍부한 기능들을 새로운 디자인으로 제공하고자 한 프로젝트입니다.
-특정 주제에 대해 채팅을 할 수 있는 "불판", 동아리나 자치단체, 소모임을 위한 "그룹 게시판", 익명 게시물, 포인트 제도 등의 기능들이
-개발되었으나 론칭되지 못하였습니다.
-
-2020년 11월에 론칭된 **_NewAra_** 는 10년간 이용되어 온 Arara를 리뉴얼한 프로젝트입니다. "가장 정확한 정보를 가장
-신속하게"라는 슬로건을 걸고 KAIST 포탈 공지를 모아 볼 수 있는 게시판 추가 및 elasticsearch 도입을 통한 발전된 검색 기능을
-제공하였습니다. Ara의 아이덴티티가 잘 드러나도록 디자인을 개선하였습니다. 단순 커뮤니티의 기능뿐만 아니라 학교, 단체 공지사항을 빠르게 확인할 수 있는 공간의 역할도 함께 하고 있습니다.
+특정 주제에 대해 채팅할 수 있는 '불판', 동아리나 자치단체, 소모임을 위한 '그룹 게시판', 익명 게시물, 포인트 제도 등의 기능이
+개발되었으나 정식으로 출시되지 못하였습니다.
 
+2020년 11월에 출시된 **_NewAra_** 는 10년간 이용되어 온 Arara를 재단장한 프로젝트입니다. '가장 정확한 정보를 가장
+신속하게'라는 슬로건을 걸고 KAIST 포탈 공지를 모아볼 수 있는 게시판 추가 및 Elasticsearch 도입을 통한 발전된 검색 기능을
+제공하였습니다. Ara의 아이덴티티가 잘 드러나도록 디자인을 개선하였습니다.
 
-## Development
+## 협업
 
-### Collaboration
-
-- 매주 1회 정기 모임과 1회 공동 코딩을 진행하고 있습니다.
+- 매주 한 번의 정기 모임와 한 번의 공동 코딩을 진행하고 있습니다.
+- Slack을 통해 소통하며 GitHub과 연동하여 commit이나 PR 등에 대한 알람을 받습니다.
 - Notion을 이용하여 개발 과정을 기록하고 정기 모임의 회의록을 작성합니다. 칸반을 이용하여 태스크를 분배합니다.
-- Slack을 통해 소통합니다. GitHub과 연동하여 commit이나 PR 등에 대한 알람을 받습니다.
 
-### GitHub Repository
+### 사용하는 기술
+
+- [Vue](https://vuejs.org/)
+- [Django](https://www.djangoproject.com/)
+- [MySQL](https://www.mysql.com/)
+- [Redis](https://redis.io/)
+- [Elasticsearch](https://www.elastic.co/)
 
-Ara는 다음 세 개의 GitHub public repository에서 개발을 진행하고 있습니다.
+### GitHub 저장소
 
-- **Web**: <https://github.com/sparcs-kaist/new-ara-web>
-- **API**: <https://github.com/sparcs-kaist/new-ara-api>
-- **App**: <https://github.com/sparcs-kaist/new-ara-app>
+- **Web**: https://github.com/sparcs-kaist/new-ara-web
+- **API**: https://github.com/sparcs-kaist/new-ara-api
+- **App**: https://github.com/sparcs-kaist/new-ara-app
 
-## Contact
+## 문의
 
-<[email protected]>
+[[email protected]](mailto:[email protected])

docs/projects/biseo.md

@@ -1,59 +1,46 @@
-# Biseo
-
-<center>
-
-## 총회 서비스
-
-<img src="/projects/biseo/logo.png" alt="Biseo - 총회 서비스" width="180"/>
+import ProjectLogo from '@site/src/components/ProjectLogo';
 
-### 스팍스 총회를 비서가 책임집니다
-
-</center>
-
-<br/>
+# Biseo
 
-## What is Biseo?
+<ProjectLogo
+    name="Biseo"
+    url="https://biseo.sparcs.org"
+    catchphrase="스팍스 총회를 비서가 책임집니다"
+/>
 
-비서는 스팍스 총회 진행을 돕는 서비스입니다. 주요 기능으로는 **투표, 채팅** 기능이 있습니다.
+## 역사
 
-<center>
-<img src="/projects/biseo/main.png" alt="Biseo Main Page" width="600"/>
+### 필요성
 
-[Main Page]
+SPARCS 종강총회 대부분의 시간은 정회원 승급 투표에 할애됩니다. 사전에 만든 구글 설문지의 링크를 공유하여 진행한 투표 과정에는 여러 불편함이 있었습니다.
 
-<img src="/projects/biseo/admin.png" alt="Biseo Admin Page" width="600"/>
+우선 20개에서 30개에 달하는 설문지를 임원진이 손수 직접 만들어야 한다는 번거로움이 존재합니다. 또한 투표를 한 사람이 아닌 하지 않은 사람을 보여주는 기능의 부재로 인해 미투표자에 대한 독촉이 늦어져 투표가 지연되는 경우가 많았습니다. 마지막으로 채팅을 전담하는 카카오톡과 투표를 전담하는 구글 설문지, 통합되지 않고 분리된 두 플랫폼 사이를 번갈아가며 이동함에 따른 피로감이 존재했습니다.
 
-[Admin Page]
+### 해결책
 
-</center>
+이렇게 Biseo는 SPARCS의 원활한 총회 진행을 돕기 위해 시작된 서비스입니다.
 
-## Why Biseo?
+Biseo의 주요 기능은 총 3가지입니다. 첫째, 투표 이전에는 SPARCS에 최적화된 투표 양식을 통한 **_안건 간편 생성 기능_**을 통해 적은 입력으로도 모든 투표 안건을 빠르게 생성할 수 있도록 돕습니다. 둘째, 투표 도중 다른 서비스로 이동하지 않아도 되어 구성원의 피로도를 낮춥니다. 이는 Biseo 내부에 의견 공유를 위한 **_실시간 채팅 기능_**과 의견 표출을 위한 **익명 투표 기능**이 모두 갖춰져 있기 때문입니다. 셋째, 투표 도중과 이후에는 관리자가 투표하지 않은 사람을 파악할 수 있습니다. 관리자는 필요 시 **_투표 독촉 기능_**을 통해 투표를 독촉하여 더 빠른 의견 수렴을 꾀할 수 있습니다.
 
-스팍스 총회에서는 정회원 승급 투표가 총회 시간의 대부분을 차지합니다. 기존에는 구글 설문지를 만들어서 링크를 공유하여 투표를 진행했지만 여러 불편함과 문제점이 있었습니다.
+Biseo는 주기적인 피드백을 기반으로 한 자유롭고 다양한 도전을 통해 꾸준히 성장하고 있습니다. 처음에는 단순한 채팅에서 시작했지만, 프로젝트 구성원의 자유로운 시도로 투표, 공유, 재적 인원 관리 기능 등이 추가되며 나날이 SPARCS에 적합한 형태로 탈바꿈하고 있습니다. 최근에는 기존 Biseo의 고질적인 문제를 해결하기 위해 새로운 디자인과 시스템을 기반으로 한 Biseo v2.0을 준비하고 있습니다.
 
-### 기존 방식의 문제점
+![Biseo Main](/projects/biseo-main.png)
 
-1. 설문지를 한땀 한땀 만들어야 하는 번거로움
-   - 20~30개의 설문지를 임원진이 만들어야 합니다.
-2. 실시간 투표 현황 파악의 어려움
-   - 설문지는 누가 어떤 투표를 했는지 보여는 주지만 **누가 투표를 하지 않은 지**는 명백하게 보여주지 않습니다.
-   - 따라서 투표하지 않은 사람을 지목할 수 없어서 투표가 지연됩니다.
-3. 채팅은 카카오톡으로, 투표는 구글 설문지로... 통합되지 않은 플랫폼
-   - 플랫폼을 번갈아가며 이동해야하는 피로감이 있습니다.
+![Biseo Admin](/projects/biseo-admin.png)
 
-### Solution
+## 협업
 
-1. 투표를 쉽고 간편하게 생성
-   - 비서는 스팍스 총회에 적합한 투표 양식을 제공하고, **간편 생성** 기능을 제공하여 적은 입력으로 많은 투표 안건들을 생성할 수 있습니다.
-2. 실시간으로 투표 현황 파악
-   - 투표하지 않은 사람들을 파악하고 투표 권유를 할 수 있습니다.
-3. 채팅과 투표의 통합
-   - 하나의 웹 사이트에서 두 가지 기능을 제공하여 다른 플랫폼으로 번갈아가며 이동할 필요가 없습니다.
+Biseo에서는 특정한 인원이 특정한 개발의 영역을 도맡는 방식을 사용하지 않습니다. 대신 모든 인원이 필요한 모든 곳에 자유롭게 기여할 수 있는 방식으로 개발을 이어나가고 있습니다. 따라서 모든 사람들이 Front-End를 개발하기도 하며, 동시에 Back-End를 개발하기도 합니다 이를 통해 Biseo는 유연하게 기능을 확장하고자 하며 동시에 폭넓게 개발 역량을 기르기 위한 유연한 형태의 서비스로 받아들여지고 있습니다.
 
-### Link
+### 사용하는 기술
 
-[https://biseo.sparcs.org](https://biseo.sparcs.org) (22.11.01부터 교내 방화벽 정책으로 교외 접근은 불가합니다.)
+- **Front-End**: React, TypeScript, JavaScript
+- **Back-End**: TypeScript, JavaScript, Express
+- **Database**: MongoDB, Redis
+- **Database for v2.0** : MySQL, Redis
 
-[https://github.com/sparcs-kaist/biseo-frontend](https://github.com/sparcs-kaist/biseo-frontend)
+### Github 저장소
 
-[https://github.com/sparcs-kaist/biseo-backend](https://github.com/sparcs-kaist/biseo-backend)
+- **Front-End**: https://github.com/sparcs-kaist/biseo-frontend
+- **Back-End**: https://github.com/sparcs-kaist/biseo-backend
+- **Front-End & Back-End for v2.0**: https://github.com/sparcs-kaist/biseo

docs/projects/geoul.md

@@ -1,3 +1,11 @@
+import ProjectLogo from '@site/src/components/ProjectLogo';
+
 # Geoul
 
+<ProjectLogo
+    name="Geoul"
+    url="https://ftp.kaist.ac.kr"
+    catchphrase="KAIST FTP"
+/>
+
 거울은 KAIST FTP라고도 불리는 오픈소스 미러링 서비스로, 전세계에 퍼져 있는 최신버전의 오픈소스 소프트웨어들을 대한민국을 포함한 아시아 국가들에게 공급합니다. 기존의 먼 곳에 위치해 있는 외국 서버들로부터 직접 다운로드 받을 필요없이, 가까운 위치의 서버에서 다운로드 받을 수 있다는 큰 장점이 있습니다. 현재 거울은 엄청난 서비스 접속량을 자랑하며 아시아 지역의 주요 미러링 서비스 중 하나로 자리하고 있습니다.

docs/projects/otl.md

@@ -1,3 +1,48 @@
+import ProjectLogo from '@site/src/components/ProjectLogo';
+
 # OTL
 
-OTL은 매 학기 개설되는 KAIST의 대부분의 과목들에 대한 정보를 쉽게 검색할 수 있게 도와줍니다. 과목들을 개인 시간표에 추가할 수 있으며 여러 개의 시간표를 한 번에 관리할 수 있습니다. 뿐만 아니라, 해당 과목에 대한 실라버스 및 해당 과목을 수강한 여러 학우들의 수강 후기를 볼 수 있어 수강 신청에 있어 많은 편의를 제공합니다. 시험을 망칠 게 뻔하니 미리 와서 다음 학기를 준비하세요.
+<ProjectLogo
+    name="OTL"
+    url="https://otl.kaist.ac.kr"
+    catchphrase="Online Timeplanner with Lectures"
+/>
+
+## 역사
+
+**_OTL_**은 과거 존재했던 강의 평가 사이트인 **_LKIN_**을 바탕으로 2009년 처음 개발되었습니다. 2009년 당시 서비스의 주된 목적은 학생들이 강의 및 교수자에 대한 평가를 공유할 수 있도록 하는 것이었습니다. 이는 KAIST에서 공식적으로 진행하는 강의 평가는 학생들에게 공개되지 않는다는 점에서 착안하였습니다. 이에 더하여, 학생들이 모의 시간표를 자유롭게 구성할 수 있도록 하는 돕는 '모의 시간표' 기능이 제공되었습니다. 학생들은 매 학기 개설되는 과목들의 강의 시간, syllabus 등을 한눈에 확인하고 미리 시간표를 구성해 볼 수 있습니다.
+
+OTL은 매 학기 4,000여 명이 넘는 KAIST 학우들이 사용하는 서비스로, 그간 크고 작은 변화를 거치며 꾸준히 발전해 왔습니다. 하지만 시간이 지남에 따라 프레임워크의 노후화, 신기술의 개발, 환경의 변화, 기능 추가의 한계 등으로 인해 재설계가 필요하게 되었습니다. 이에 따라 2015년에 **_OTL Plus_**라는 이름의 프로젝트가 시작되었습니다.
+
+기존 OTL을 종료하고 2016년에 배포된 OTL Plus는 다음의 개선점을 가지고 있습니다. 과목사전의 후기 작성이 더욱 편리해졌으며, 검색 기능이 강화되었습니다. 또한 과목 후기에 '좋아요'를 남길 수 있게 되었습니다. 모의시간표에는 장바구니, 후기 미리보기, 시간표 복사 등 다양한 기능들이 추가되었습니다. 전체적으로 개선된 UI가 적용되었고, 이에 따라 과목사전과 모의시간표 간의 연계가 강화되었습니다. OTL Plus는 현재 과거와 같이 **_OTL_**로 이름을 통합하여 서비스되고 있습니다. 이는 KAIST 학우들의 혼란을 방지하기 위함입니다.
+
+2020년에는 모바일로 OTL에 접근하는 학생들이 증가하고 있는 시대 상황을 반영하여 **_OTL App_** 프로젝트가 새로이 시작되었습니다. 기존에 모바일용 웹 페이지가 제공되고 있었으나, 이것만으로는 부족하다는 판단하에 학생들의 편이성을 증진하기 위한 방법을 모색한 결과입니다. OTL App 프로젝트는 현재도 활발히 진행 중이며, 2023년 가을 이전 배포를 목표로 하고 있습니다.
+
+2023년에는 NestJS 프레임워크 기반 백엔드로의 이전 준비를 시작하였습니다. OTL 서비스가 오래 지속되면서 과거 Django2.1로 작성된 코드를 이용해 기능을 개발하거나 버그를 수정하는 속도가 비교적 더뎌지는 문제가 발생하였습니다. 그렇기 때문에 이러한 문제 상황을 근본적으로 해결하고자 최신 프레임워크의 도입을 결정하였고, 향후 1년의 기간이 소요될 것으로 예상됩니다.
+
+## 협업
+
+- Web TF, App TF로 나뉘어 매주 1회 정기 모임을 진행하고 있습니다. 필요한 경우 공동 코딩을 추가로 진행합니다.
+- Slack을 통해 소통합니다.
+  - 과거에는 **#otl**을 주로 사용하였으나, 현재는 새로 개설한 **#otl-plus**을 주요한 소통창구로 사용하고 있습니다.
+  - 앱 개발 관련 대화는 **#otl-app**에서 많이 나누고 있습니다.
+  - **#otl-notify**과 **#otl-app-notify**에서 Notion과 GitHub Webhook을 추가하여 사용하고 있습니다.
+- Notion을 이용해 디자인 문서, 기능 제안, 회의록 등의 자료를 정리하여 보관하고 있습니다.
+
+![OTL Notion](/projects/otl-notion.png)
+
+### 사용하는 기술
+
+- **Web**: UI 프레임워크는 React, 전역 상태관리 라이브러리는 Redux를 사용하고 있습니다. JavaScript를 통한 PropTypes로 작성되었으나 TypeScript 및 React Functional Component로 다시 작성하고 있습니다.
+- **App**: Flutter로 제작하였습니다.
+- **Server**: Django 2.1로 제작되었으나 TypeScript 기반의 NestJS 프레임워크로 이전하고 있습니다.
+
+### GitHub 저장소
+
+- **Web**: https://github.com/sparcs-kaist/otlplus
+- **App**: https://github.com/sparcs-kaist/otl-app
+- **Server Migration:** https://github.com/sparcs-kaist/otl-nest
+
+## 문의
+
+[[email protected]](mailto:[email protected])

docs/projects/sso.md

@@ -1,3 +1,11 @@
+import ProjectLogo from '@site/src/components/ProjectLogo';
+
 # SSO
 
+<ProjectLogo
+    name="SSO"
+    url="https://sparcssso.kaist.ac.kr"
+    catchphrase="SPARCS의 모든 서비스를 한 번에"
+/>
+
 SPARCS 서비스 로그인을 하나의 계정으로 할 수 있도록 해주는 Single Sign On 서비스입니다. KAIST Portal 연동을 통해 KAIST 구성원임을 인증하고 실명, 생일, 학번 등 개인 정보를 저장하여 SPARCS 서비스에 제공합니다.