# Code-us 프로젝트

## 프로젝트 개요

Code-us 프로젝트는 React, Vite, TailwindCSS를 사용한 프론트엔드와 NestJS를 사용한 백엔드로 구성된 동아리 홈페이지입니다. 이 프로젝트는 다음과 같은 주요 섹션으로 구성된 동아리 홈페이지를 제공합니다:
- 배경
- 핵심 가치
- 동아리 부원 소개
- 동아리 소개
- 프로젝트 결과물
- 코더스는 어때요?

메뉴는 다음과 같습니다:
- Introduce
- Project
- Support
- Blog

## 기술 스택

### 프론트엔드
- **React**: 사용자 인터페이스를 구축하기 위한 라이브러리
- **Vite**: 빠르고 간편한 개발 환경 설정을 위한 빌드 도구
- **TypeScript**: 정적 타입을 지원하는 자바스크립트의 상위 집합
- **TailwindCSS**: 유틸리티 클래스 기반의 CSS 프레임워크

### 백엔드
- **NestJS**: 효율적이고 확장 가능한 Node.js 서버 애플리케이션 프레임워크
- **TypeScript**: 정적 타입을 지원하는 자바스크립트의 상위 집합

## 디렉토리 구조

```plaintext
code-us/
  ├── packages/
  │   ├── backend/           # 백엔드 NestJS 프로젝트
  │   │   ├── src/
  │   │   ├── test/
  │   │   ├── .eslintrc.js
  │   │   ├── nest-cli.json
  │   │   ├── package.json
  │   │   ├── tsconfig.json
  │   │   └── ...
  │   └── frontend/          # 프론트엔드 React 프로젝트
  │       ├── src/
  │       ├── public/
  │       ├── .eslintrc.js
  │       ├── index.html
  │       ├── package.json
  │       ├── tsconfig.json
  │       └── ...
  ├── .gitignore
  ├── package.json
  └── README.md

설치 및 실행 방법

1. 저장소 클론

먼저, GitHub 저장소를 클론합니다:

git clone https://github.com/username/repository.git
cd repository

2. 의존성 설치

루트 디렉토리에서 모든 의존성을 설치합니다:

yarn install

3. 프론트엔드 실행

프론트엔드 서버를 실행하려면 다음 명령어를 사용합니다:

yarn start:frontend

프론트엔드 서버는 기본적으로 http://localhost:5173에서 실행됩니다.

4. 백엔드 실행

백엔드 서버를 실행하려면 다음 명령어를 사용합니다:

yarn start:backend

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

기타 명령어

프론트엔드 빌드

프론트엔드 애플리케이션을 프로덕션용으로 빌드하려면 다음 명령어를 사용합니다:

yarn workspace frontend build

백엔드 테스트

백엔드 애플리케이션의 테스트를 실행하려면 다음 명령어를 사용합니다:

yarn workspace backend test

기여 방법

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

라이선스

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

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