Skip to content

Commit

Permalink
DOCS : 프로젝트 README 기입
Browse files Browse the repository at this point in the history
- 1차 작성 완료 하였습니다.
  • Loading branch information
hanseu9839 authored Jan 14, 2025
1 parent 444ebcc commit 9fe6d10
Showing 1 changed file with 22 additions and 61 deletions.
83 changes: 22 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,22 @@
### 💡 아이디어명
**프로덕트 이름** : ITZip

### 웹 사이트 URL : [취준생사이트](https://itzip.co.kr)

### 📝 아이디어 계기
- **기획 배경** : 추후 기입 예정
- **기획 배경** : **효율적인 개발자 취업 준비 플랫폼** <br/>
개발자 취업 준비 과정에서 느꼈던 여러 불편함을 해결하고, 더 나은 경험을 제공하기 위해 이 플랫폼을 개발했습니다.


### 📄 아이디어 설명
- **설명** : 추후 기입 예정
- **설명** : 이 플랫폼은 알고리즘 학습, 이력서 작성, 채용 공고 검색 등 취업 준비의 핵심 요소를 한 곳에서 관리할 수 있도록 설계되었습니다.

### 🪄 기대 효과
- **설명** : 추후 기입 예정

<br/>
### 🪄 기대 효과
- **설명** : 사용자가 효율적으로 취업을 준비할 수 있도록 불편한 점을 개선하고, 취업 성공까지 전 과정을 지원하는 것을 목표로 하고 있습니다.

## 🛠️ 기술 스택

### 🎨 프론트엔드

- **React** : 추후 기입 예정

- **Next.js** : 추후 기입 예정

- **TypeScript** : 추후 기입 예정

- **Jotai** : 추후 기입 예정

- **Tailwind** : 추후 기입 예정

- **StoryBook** : 추후 기입 예정

### 💻 백엔드

- **JWT** : Spring Security를 활용하기 위한 수단으로 사용한다.
Expand All @@ -48,11 +37,9 @@

- **PostgreSQL** : 오픈소스이면서 호환성 및 유연성이 좋고, 대량의 데이터를 처리하는 성능이 뛰어나기 때문에 채택한다.

- **LocalStack** : 추후 기입 예정

- **ELK** : 미정
- **ElasticSearch** : 학교 데이터를 인덱싱을 통하여 검색어 최적화를 위해 채택하였다.

- **Java** : 추후 기입 예정
- **Java** : 자바 21버전 채택하였다.

- **Spring Boot** : 스프링 부트는 대중적이면서도 확장성이 좋아 이후 고도화 단계까지 고려해서 채택한다.

Expand All @@ -66,16 +53,12 @@

- **GitHub** : 버전 관리 및 기능 개발 협업을 위해 채택한다.

- **Jekins** : 추후 기입 예정
- **GihubActions** : 깃허브 액션을 통하여 CI/CD를 구축을 위하여 채택하였다.

- **Docker** : 추후 기입 예정
- **Docker** : Docker, Docker-Compose 사용하여 Nginx, Certbot, LetsEncrypt, Backend, Front 도커 컨테이너 생성하여 관리하기 위해 채택하였다.

- **Nginx** : 추후 기입 예정

- **Ubuntu** : 추후 기입 예정

- **Kubernetes** : 추후 기입 예정

- **AWS(Amazon Web Services)** : 클라우드 컴퓨팅 플랫폼으로, 서버 배포 및 이미지 저장소로 활용한다.

<br/>
Expand All @@ -100,49 +83,33 @@

## 📮 협업 도구

- **Slack** : 실시간 회의록 작성 및 내용을 공유한다.
- **Slack** : 프론트, 백엔드 실시간 회의록 작성 및 내용을 공유한다.

- **Discord** : 팀원들과의 실시간 음성대화파일전송 기능을 활용한다.
- **Discord** : 팀원들과의 실시간 음성대화, 파일전송 기능, GihubActions CI/CD 성공 or 실패 메시지기능 활용한다.

- **Notion** : 비지니스 로직 및 아키텍쳐 설계를 공유한다.

<br/>

## 📜 문서 도구

- **ERD Cloud** : 추후 기입 예정

- **Draw.io** : 추후 기입 예정
- **ERD Cloud** : [ERD 사이트](https://www.erdcloud.com/d/uBYB6CmA26fGitZtY)

- **Swagger** : 추후 기입 예정
- **Swagger** : [swagger 사이트](http://3.39.78.0:8080/api/swagger-ui/index.html)

- **Figma** :

<br/>

## 📅 개발 일정 (마일 스톤 활용 예정)

- **1주차** :

- **2주차** :

- **3주차** :

- **4주차** :

- **5주차** :
- **Figma** : [피그마 사이트](https://www.figma.com/design/ALY0rJLloDoU43tzvVrdsg/%EC%B7%A8%EC%B7%A8%ED%94%84?node-id=124-250&t=z0xnhWO4g6lj4zJy-0)

<br/>

## 👥 업무 분담

- **한승균** :
- **한승균** : ERD , 이력서, 공통파일 업로드, 초기 환경 구축, 채용 공고, 테스트 코드 Wiki, 깃허브 이슈 Wiki 문서 작성

- **김채민** :
- **김채민** : ERD , 회원 , Security, OAuth2.0, Wiki 깃허브 작성, CORS 오류 설정, JWT

- **신효승** :
- **신효승** : ERD , 세부 인프라 구축, Blog ,랭킹 시스템 (예정)

- **박석원** :
- **박석원** : ERD, 공통 응답 처리, 스웨거, 알고리즘

<br/>

Expand All @@ -156,12 +123,6 @@

- **Git 브랜치 전략** : GitHub-Flow

- **커밋 메시지 규칙** : commit 컨벤션 Page 참고
- **커밋 메시지 규칙** : commit 컨벤션 Page wiki 참고

<br/>

## 📚 문서 관리

- **관리 방법 1** : 추후 기입 예정

- **관리 방법 2** : 추후 기입 예정

0 comments on commit 9fe6d10

Please sign in to comment.