About the Project 🎬 - WATCHVIE

Watch Movie의 줄임말로 영화 API를 이용한 영화 정보를 제공하는 웹 서비스입니다.

영화 제목, 장르, 개봉일, 인기도 등의 정보를 제공합니다.

Contents

• Team Member
  
• Getting Start
  
• Project Architecture
  
• Usage
  
• Roadmap
  
• Contributing
  
• Environment
  
• Convention
  
• License
  

1. Team Member

이동현	김담인	홍승표	루창

2. Installation

Install NPM Dependencies

• npm-install

> npm install

Set .env

• create .env in root folder

PORT="YOUR_PORT_NUMBER"
SESSION_SECRET="YOUR_SESSION_SECRET"
TMDB_KEY="YOUR_TMDB_KEY"
DB_URL="YOUR_MONGO_DB_URL"

Start Dev Server

• npm-start

> npm start

3. Project Architecture

4. Usage

주요 기능 소개

• Home page
  메인 페이지에서 인기있는 영화 목록을 보여줍니다.
  옵션(1) 상단의 내비게이션 바에서 5가지 장르 중 맘에 드는 장르를 선택합니다.
  옵션(2) 내비게이션 바 우측 상단의 로그인 및 회원가입 버튼으로 WATCHVIE에 사용자 정보를 등록할 수 있습니다.
  옵션(3) 상단의 내비게이션 바 좌측의 팀 로고인 WATCHVIE를 누르면 어떤 화면에 있던지 메인으로 돌아갑니다.
  옵션(4) 영화에 대한 정보를 검색하여 확인해볼 수 있습니다.
  

• 로그인된 상태
  로그인 후 메인화면입니다. 내비게이션 바 우측 상단의 로그아웃 버튼을 누르면 앞선 홈화면의 형태로 돌아갑니다.

• SignUp page
  homepage에서 옵션(2)의 SingUp버튼을 누르면 위 화면으로 이동합니다.
  이메일,이름,ID,PW(password)를 입력하여 회원가입 절차를 진행합니다.
  화면 하단의 SignUp 버튼을 누르면 SignIn page로 넘어갑니다.
  

• SignIn page
  homepage에서 옵션(2)의 SignIn버튼을 누르면 위 화면으로 이동합니다.
  UserID와 PW를 입력하고 하단의 SignIn 버튼을 눌러 페이지에 로그인합니다.
  

5. Roadmap

Backend

1️⃣ 프로젝트 세팅 및 예제 코드 생성

2️⃣ 영화 정보 제공 API 구성

3️⃣ MongoDB 세팅 및 Schema 생성

4️⃣ 회원가입 및 로그인 API 구성

5️⃣ Github action을 통한 CI, CD 구성 ( 배포 - AWS EC2 )

6️⃣ 영화 찜하기 API 구성

7️⃣ 리팩토링

6. Contributing

프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.

1. 프로젝트 fork
2. feature branch 생성 (git checkout -b feature/name)
3. commit (git commit -m "Add feature)
4. push (git push origin feature/name)
5. pull request 생성

Pull request는 최대한 빨리 확인하도록 하겠습니다. 

pull request 포함 문의사항은 📧contact 으로 연락 부탁드립니다.

7. Environment

• Language
  

• Framework
  

• DataBase
  

8. Convention

Commit Convention

• Conventional Commit

• Commit msg commit의 종류는 위와 같이 구분합니다.

Work Flow

1. ISSUE 생성
   작업에 대한 정보를 포함한 ISSUE를 생성합니다.
   
2. 생성된 ISSUE에 대해 Draft PR 생성
   ISSUE를 연결하여 관리하고 Pair Programming을 어느정도 진행하기 위해 Draft PR을 생성합니다.
   
3. 작업을 마친후 PR Open 및 코드 리뷰
   작업이 끝나게 되면 Draft PR을 일반 PR로 변경하고 서로 코드 리뷰를 진행합니다.
   
4. Merge & PR Close & Remove Branch
   코드 리뷰까지 모두 마리가 되면 해당 브런치를 dev에 merge하고 pr 닫기 및 브런치 삭제를 진행합니다.
   

9. License

movie-server is licensed under the MIT License