README.md

SCS (Study Computer Science)

SCS는 컴퓨터 과학 전공 지식을 학습하기 위한 웹 서비스입니다. CS 분야별로 전공 지식에 대한 면접 질문과 그에 대한 답변을 커뮤니티 형태로 관리합니다.

프로젝트 구조

• docs/: SCS의 소프트웨어 설계 문서
• frontend/: SCS의 프론트엔드 프로젝트
• backend/: SCS의 백엔드 프로젝트

프로젝트 아키텍처

주요 기능

• 섹션별 질문 관리 (네트워크, 데이터베이스, 자바스크립트 등)
• 질문에 대한 다양한 답변 제공
• 답변에 대한 댓글 및 추천 기능
• 개인화된 학습 자료 생성 (Book 기능)

기술 스택

Front-end

• React
• TypeScript
• Vite

Back-end

• NestJS
• TypeORM
• PostgreSQL
• JWT

Common

• Swagger API
• AWS S3
• Docker
• Docker-compose
• Git

현재 개발 현황

Back-end

• 사용자 인증 (Auth) 모듈
• 사용자 (User) 모듈
• 섹션 (Section) 모듈
• 질문 (Question) 모듈
• 업로드 (Upload) 모듈
• 답변 (Action) 모듈
• 댓글 (Comment) 모듈
• 북 (Book) 모듈
• 문의사항 (Board) 모듈

Front-end

• 홈페이지, 헤더, 푸터
• 회원 가입 페이지 및 이메일 인증 회원가입 기능
• 로그인 페이지 및 JWT 로그인 기능
• 섹션 목록 페이지 (Section page)
• 액션 목록 페이지 (Question page)
• 액션 작성 페이지 및 마크다운 리치 텍스트 에디터 글 작성 기능
• 액션 수정 페이지
• 액션 상세 페이지 및 댓글 기능
• 문제집 페이지
• 마이페이지
• 최적화

API Documentation

현재 개발된 API에 대한 문서는 여기에서 확인할 수 있습니다.

Commit Convention

• 초기 커밋: Init
• 기능 추가: Feat
• 버그 수정: Fix
• 코드 리팩토링: Refactor
• 문서 업데이트: Docs
• 성능 개선: Perf
• 스타일 변경: Style
• 코드 제거: Remove
• 테스트 추가: Test
• 의존성 업데이트: Deps
• 데이터베이스 마이그레이션: DB
• 오타 수정: Typo

Licenses

프로젝트의 라이센스와 관련한 부분은 LICENSES에서 확인할 수 있습니다.

Contact

프로젝트 관리자 - @youth_1nn - [email protected]

프로젝트 링크: https://github.com/Yush1nk1m/SCS