이 레파지토리는 참여자들이 해커톤 결과물을 위한 레파지토리 생성시에 참고할 내용들을 담고 있습니다.
- 레파지토리 생성
- 레파지토리 구성
- README.md 가이드라인
- README.md 작성팁
- https://classroom.github.com/a/mrBmI_GF
- 위 Github Classroom 링크에 접속해 본인 조의 github 레파지토리를 생성하세요.
- 레파지토리 생성 시 팀 이름은
{연도}-TEAM-{조번호}형식으로 생성하세요. - 예를 들어, 2024년도 3조의 팀명은
2024-TEAM-03입니다. - 이 경우
PNUSW-2024-TEAM-03이라는 이름으로 레포지토리가 생성됩니다.
- 레파지토리 내에
README.md파일 생성하고 아래의 가이드라인과 작성팁을 참고하여 파일을 작성하세요. - 레파지토리 내에
docs폴더를 생성하고 폴더 내에는 과제 수행 하면서 작성한 각종 보고서, 발표자료를 올려둡니다. - 그 밖에 레파지토리의 폴더 구성은 과제 결과물에 따라 자유롭게 구성하되 가급적 코드의 목적이나 기능에 따라 폴더를 나누어 구성하세요.
- README 파일 작성시에 아래의 5가지 항목의 내용은 필수적으로 포함해야 합니다.
- 아래의 7가지 항목이외에 프로젝트의 이해를 돕기위한 내용을 추가해도 됩니다.
SAMPLE_README.md가 단순한 형태의 예제이니 참고하세요.
### 1. 프로젝트 소개
#### 1.1. 개발배경 및 필요성
> 프로젝트를 실행하게 된 배경 및 필요성을 작성하세요.
#### 1.2. 개발 목표 및 주요 내용
> 프로젝트의 목표 및 주요 내용을 작성하세요.
#### 1.3. 세부내용
> 위 내용을 작성하세요.
#### 1.4. 기존 서비스 대비 차별성
> 위 내용을 작성하세요.
#### 1.5. 사회적가치 도입 계획
> 위 내용을 작성하세요.
### 2. 상세설계
#### 2.1. 시스템 구성도
> 시스템 구성도(infra, front, back등의 node 간의 관계)의 사진을 삽입하세요.
#### 2.1. 사용 기술
> 스택 별(backend, frontend, designer등) 사용한 기술 및 버전을 작성하세요.
>
> ex) React.Js - React14, Node.js - v20.0.2
### 3. 개발결과
#### 3.1. 전체시스템 흐름도
> 위 내용을 작성하세요.
#### 3.2. 기능설명
> 각 페이지 마다 사용자의 입력의 종류와 입력에 따른 결과 설명 및 시연 영상.
>
> ex. 로그인 페이지:
>
> - 이메일 주소와 비밀번호를 입력하면 입력창에서 유효성 검사가 진행됩니다.
>
> - 요효성 검사를 통과하지 못한 경우, 각 경고 문구가 입력창 하단에 표시됩니다.
>
> - 유효성 검사를 통과한 경우, 로그인 버튼이 활성화 됩니다.
>
> - 로그인 버튼을 클릭 시, 입력한 이메일 주소와 비밀번호에 대한 계정이 있는지 확인합니다.
>
> - 계정이 없는 경우, 경고문구가 나타납니다.
>
> (영상)
#### 3.3. 기능명세서
> 개발한 제품에 대한 기능명세서를 작성해 제출하세요.
>
> 노션 링크, 한글 문서, pdf 파일, 구글 스프레드 시트 등...
#### 3.4. 디렉토리 구조
> 위 레포지토리의 디렉토리 구조를 설명하세요.
### 4. 설치 및 사용 방법
> 제품을 설치하기 위헤 필요한 소프트웨어 및 설치 방법을 작성하세요.
>
> 제품을 설치하고 난 후, 실행 할 수 있는 방법을 작성하세요.
### 5. 소개 및 시연 영상
> 프로젝트에 대한 소개와 시연 영상을 넣으세요.
> 프로젝트 소개 동영상을 교육원 메일([email protected])로 제출 이후 센터에서 부여받은 youtube URL주소를 넣으세요.
### 6. 팀 소개
> 팀원 소개 & 구성원 별 역할 분담 & 간단한 연락처를 작성하세요.
### 7. 해커톤 참여 후기
> 팀원 별 해커톤 참여 후기를 작성하세요.- 마크다운 언어를 이용해 README.md 파일을 작성할 때 참고할 수 있는 마크다운 언어 문법을 공유합니다.
- 다양한 예제와 보다 자세한 문법은 이 문서를 참고하세요.
# This is a Header 1
## This is a Header 2
### This is a Header 3
#### This is a Header 4
##### This is a Header 5
###### This is a Header 6
####### This is a Header 7 은 지원되지 않습니다.
####### This is a Header 7 은 지원되지 않습니다.
> This is a first blockqute.
> > This is a second blockqute.
> > > This is a third blockqute.
This is a first blockqute.
This is a second blockqute.
This is a third blockqute.
- Ordered List
1. first
2. second
3. third
- first
- second
- third
- Unordered List
* 하나
* 둘
+ 하나
+ 둘
- 하나
- 둘
- 하나
- 둘
- 하나
- 둘
- 하나
- 둘
- 코드 블럭 이용 '``'
여러줄 주석 "```" 이용
"```
#include <stdio.h>
int main(void){
printf("Hello world!");
return 0;
}
```"
단어 주석 "`" 이용
"`Hello world`"
* 큰 따움표(") 없이 사용하세요.
[Title](link)
[부산대 소프트웨어융합교육원](https://swedu.pusan.ac.kr/swedu/index.do)
<link>
<https://swedu.pusan.ac.kr>
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
~~cancelline~~
single asterisks
single underscores
double asterisks
double underscores
cancelline
<img src="/path/to/img.jpg" width="600px" title="Title" alt="Alt text"></img>
