[프로젝트] 1. Spring Boot 생성 및 README.md 작성

프로젝트 (Java)/예약마켓

[프로젝트] 1. Spring Boot 생성 및 README.md 작성

hihyuk 2024. 1. 24. 22:31

스프링 부트 프로젝트 설정

1. [Spring Initializr](https://start.spring.io/) 접속: 이 사이트를 통해 스프링 부트 프로젝트의 기본 구조를 생성할 수 있습니다.

2. 프로젝트 설정:
   - Project: Gradle Project 선택
   - Language: Java 선택
   - Spring Boot: SNAPSHOT이 없는 최신 버전 선택 (SNAPSHOT 버전은 개발 중인 버전이므로 안정성이 보장되지 않습니다.)
   - Project Metadata:
     - Group: `com`
     - Artifact: `myshop`
     - Name: `myshop`
     - Description: 프로젝트에 대한 간단한 설명 (선택사항)
     - Package name: 자동으로 생성되며, 필요에 따라 수정 가능
     - Packaging: Jar (웹 애플리케이션을 배포할 때 주로 사용되는 형식)
     - Java version: 17 선택
   - Dependencies: `Spring Web`, `Lombok` 추가

3. 프로젝트 생성: 설정이 완료되면 `Generate` 버튼을 클릭해 프로젝트 압축 파일을 다운로드하고, 원하는 위치에 압축을 해제합니다.

GitHub을 사용한 버전 관리

1. 깃 저장소 초기화 및 첫 커밋:

git init
git add .
git status
git commit -m "커밋 메세지"

   - 터미널을 열고 프로젝트 폴더로 이동
   - `git init`: 깃 저장소 생성 (.git 디렉토리가 생성됩니다)
   - `git add .`: 현재 폴더의 모든 파일을 스테이징 영역에 추가 (`.gitignore`에 명시된 파일은 제외)
   - `git status`: 스테이징된 파일 확인
   - `git commit -m "초기 커밋 메시지"`: 변경사항을 커밋

2. GitHub에 리포지토리 생성 및 코드 푸시

git remote add origin 레포지토리 주소
git push -u origin master

   - GitHub에서 새로운 리포지토리 생성
   - 생성된 리포지토리 페이지에서 제공하는 `레포지토리 주소`를 복사
   - 터미널에서 `git remote add origin 레포지토리 주소` 실행하여 리모트 저장소 설정
   - `git push -u origin master` (또는 `main`, 브랜치 명칭에 따라 다를 수 있음) 실행하여 GitHub에 코드 푸시

README.md 작성

프로젝트의 루트 디렉토리에 README.md 파일을 생성합니다.
Markdown 언어를 사용하여 프로젝트에 대한 설명, 설치 방법, 사용 방법 등을 작성합니다.
프로젝트를 진행하면서 README.md 파일을 지속적으로 업데이트하여 프로젝트에 대한 정보를 제공합니다.

GitHub의 README.md는 프로젝트를 방문하는 사람들에게 첫 인상을 주는 중요한 부분입니다. 프로젝트의 목적, 기능, 설치 및 사용 방법 등을 명확하게 기술하여 프로젝트의 가치를 전달하는 것이 좋습니다.