https://github.com/ai-x-4-a1-final/narrativa_develop

Narrativa Docker Repository
https://github.com/ai-x-4-a1-final/narrativa_develop

backend frontend ml

Last synced: 3 months ago
JSON representation

Narrativa Docker Repository

Host: GitHub
URL: https://github.com/ai-x-4-a1-final/narrativa_develop
Owner: AI-X-4-A1-FINAL
License: mit
Created: 2024-11-23T00:05:08.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2024-11-30T08:09:42.000Z (over 1 year ago)
Last Synced: 2025-03-22T07:17:02.853Z (over 1 year ago)
Topics: backend, frontend, ml
Language: TypeScript
Homepage: http://221.148.97.238:3010
Size: 65.4 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![NARRATIVA-TITLE](https://github.com/user-attachments/assets/97538156-f202-4b48-8543-9bbf835fda0e)

# Narrativa Develop

![Spring Boot](https://img.shields.io/badge/Spring%20Boot-v3.3.5-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
![Spring Security](https://img.shields.io/badge/Spring%20Security-v6.2.4-6DB33F?style=for-the-badge&logo=springsecurity&logoColor=white)
![MySQL](https://img.shields.io/badge/MySQL-8.4.3%20LTS-4479A1?style=for-the-badge&logo=mysql&logoColor=white)

![React](https://img.shields.io/badge/React-18.3.1-61DAFB?style=for-the-badge&logo=react&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-4.9.5-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/TailwindCSS-3.4.15-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white)

![Python](https://img.shields.io/badge/Python-v3.12.7-3776AB?style=for-the-badge&logo=python&logoColor=white)
![PyTorch](https://img.shields.io/badge/PyTorch-v2.5.1-EE4C2C?style=for-the-badge&logo=pytorch&logoColor=white)
![FastAPI](https://img.shields.io/badge/FastAPI-v0.115.4-009688?style=for-the-badge&logo=fastapi&logoColor=white)

## 🗝️ 프로젝트 소개

> 개발환경을 통일하기 위한 리포지토리입니다.

### 사전 요구사항

+ Git
+ Docker
+ Docker Compose

### 설치 단계

#### 1. 프로젝트 클론
> 프로젝트를 로컬 환경으로 가져오기 위해 다음 명령어를 실행합니다:
```bash
$ git clone https://github.com/AI-X-4-A1-FINAL/Narrativa_Develop.git
$ cd narrativa-develop
```
#### 2. 서브모듈 설정
> 프로젝트의 서브모듈을 초기화하고 업데이트하는 방법은 두 가지가 있습니다:
+ 방법 1: 기본 클론 후 서브모듈 설정
```bash
# 서브모듈 초기화
$ git submodule init

# 서브모듈 업데이트
$ git submodule update
```
+ 방법 2: 서브모듈을 포함한 직접 클론
```bash
$ git clone --recurse-submodules https://github.com/AI-X-4-A1-FINAL/Narrativa_Develop.git
```

#### 3. 환경 변수 설정

+ AWS CLI 설정
```bash
$ aws configure
# AWS Access Key ID 입력
# AWS Secret Access Key 입력
# Default region name: ap-northeast-2
# Default output format: json
```

+ 환경 변수 가져오기
```bash
# 필요한 패키지 설치
$ npm install

# S3 버킷에서 환경변수 가져오기
$ npm run fetch-env
```

#### 4. 서브모듈 관리
+ 서브모듈 업데이트
> 서브모듈의 내용이 변경되었을 경우 다음 명령어로 최신 변경사항을 가져올 수 있습니다
```bash
# 모든 서브모듈을 최신 버전으로 업데이트
$ git submodule update --remote

# 또는 각 서브모듈의 dev 브랜치에서 풀
$ git submodule foreach git pull origin dev
```

#### 4. 서비스 실행
```bash
# Docker Compose로 서비스 실행
$ docker-compose up --build
```

#### 문제 해결

#### 주의사항

+ AWS CLI가 설치되어 있어야 합니다
+ AWS 자격증명이 올바르게 설정되어 있어야 합니다
+ Parameter Store에 필요한 환경변수가 미리 설정되어 있어야 합니다
+ .env 파일은 .gitignore에 포함되어 있으므로 git에 커밋되지 않습니다

#### 문제 해결

+ 환경변수 가져오기 실패 시: AWS 자격증명 확인
+ 서브모듈 업데이트 실패 시: 로컬 변경사항 확인
+ Docker 빌드 실패 시: 로그 확인 및 환경변수 설정 확인

## 🗝️ 브랜치 관리 규칙

### 브랜치 구조

1. **메인 브랜치 (main)**

- 프로덕션 배포용 안정 브랜치
- PR을 통해서만 병합 가능

2. **개발 브랜치 (dev)**

- 개발 중인 기능 통합 브랜치
- 배포 전 최종 테스트 진행

3. **기능 브랜치 (feat/)**

- 새로운 기능 개발용
- 명명규칙: `feat/{기능명}`
- 예: `feat/social-login`

4. **긴급 수정 브랜치 (hotfix/)**
- 프로덕션 긴급 버그 수정용
- 명명규칙: `hotfix/{이슈번호}`
- 예: `hotfix/critical-bug`

### 브랜치 사용 예시

```bash
# 기능 브랜치 생성
git checkout -b feat/social-login

# 긴급 수정 브랜치 생성
git checkout -b hotfix/critical-bug
```

## 🗝️ 디렉토리 구조

```
NARRATIVA-ADMIN/
├── node_modules/ # 프로젝트 종속성 패키지
├── public/ # 정적 파일 디렉토리
├── src/ # 소스 코드
│ ├── assets/ # 이미지, 폰트 등 리소스 파일
│ ├── components/ # 재사용 가능한 컴포넌트
│ │ ├── Dashboard/ # 대시보드 관련 컴포넌트
│ │ ├── UserManagement/ # 회원 관리 관련 컴포넌트
│ │ └── Notice/ # 공지사항 관련 컴포넌트
│ ├── hooks/ # 커스텀 훅
│ ├── pages/ # 페이지 컴포넌트
│ ├── services/ # API 및 유틸리티 함수
│ └── types/ # TypeScript 타입 정의
├── .gitignore # Git 무시 파일 목록
├── LICENSE # 라이센스 정보
├── package.json # 프로젝트 설정 및 종속성
├── README.md # 프로젝트 문서
├── tailwind.config.js # Tailwind CSS 설정
└── tsconfig.json # TypeScript 설정
```

## 🗝️ 팀 정보

### **Team Member**

## 🗝️ 문의 및 기여

프로젝트에 대한 문의사항이나 개선 제안은 이슈 탭에 등록해주세요.

기여를 원하시는 분은 Fork & Pull Request를 통해 참여해주시면 감사하겠습니다.

## 🗝️ 라이선스

이 프로젝트는 [MIT 라이선스](LICENSE)를 따릅니다.

![footer](https://github.com/user-attachments/assets/c30abbd9-8e89-4a4e-8823-33fe0cf843c9)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/ai-x-4-a1-final/narrativa_develop

Awesome Lists containing this project

README