멤버

2024-07-25 ~

FE 김선희

FE 김지현

FE 이진선

BE 김혜승

BE 이지인

프로젝트 사용 기술

프로젝트 폴더 구조

폴더 구조 작성 cmd 명령어 : 'tree > level.txt' 

└─src
    ├─main
    │  ├─kotlin
    │  │  └─kr
    │  │      └─hs
    │  │          └─study
    │  │              └─codeusbackend
    │  └─resources
    │      ├─static
    │      └─templates
    └─test
        └─kotlin
            └─kr
                └─hs
                    └─study
                        └─codeusbackend

기여 방법

기여를 원하시는 분들은 먼저 이슈를 등록해 주세요. 그 후, fork한 저장소에서 작업한 후 풀 리퀘스트를 보내주시면 됩니다.

런타임 구동

1. 저장소 클론

먼저, GitHub 저장소를 로컬에 복제합니다.

git clone https://github.com/CODE-U-S/CodeUS-Backend.git
cd CodeUS-Backend

2. dependency 설치

루트 디렉토리에서 모든 dependecy를 다운받습니다.

3. 백엔드 실행

백엔드 실행 시, application.yml에서 필요한 환경 변수를 설정해야 합니다. 설정하는 방법

백엔드 서버는 기본적으로 http://localhost:8080 에서 실행됩니다.

Environment variables는 다음과 같습니다.

DB_HOST=;DB_PORT=;DB_NAME=;DB_USERNAME=;DB_PASSWORD=;REDIS_HOST=;REDIS_PORT=;DDL_AUTO=;JWT_SECRET=;

Commit Convention

value	meaning
feat	새로운 기능 추가
add	새로운 클래스 추가
fix	버그 수정
docs	문서 변경
refactor	리팩토링
move	파일 또는 폴더 이동
test	테스트 관련 사항
chore	기타

라이선스

이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE 파일을 참조하세요.

위의 README 파일은 프로젝트에 대한 전반적인 정보를 포함하고 있습니다. 자신의 프로젝트에 맞게 내용을 수정하여 사용하면 됩니다. 이 파일을 프로젝트의 루트 디렉토리에 `README.md` 파일로 저장하면 됩니다.