Skip to content

khu-open-source/movie-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

header

About the Project ๐ŸŽฌ - WATCHVIE

Watch Movie์˜ ์ค„์ž„๋ง๋กœ ์˜ํ™” API๋ฅผ ์ด์šฉํ•œ ์˜ํ™” ์ •๋ณด๋ฅผ ์ œ๊ณตํ•˜๋Š” ์›น ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.

์˜ํ™” ์ œ๋ชฉ, ์žฅ๋ฅด, ๊ฐœ๋ด‰์ผ, ์ธ๊ธฐ๋„ ๋“ฑ์˜ ์ •๋ณด๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

contents

1. Team Member




์ด๋™ํ˜„ ๊ณ ์œค์„ฑ ์กฐ์˜ˆ๋ฆฐ

2. Installation

Install NPM Dependencies

> npm install

Start Dev Server

> npm start

3. Project Architecture

แ„Œแ…ฆแ„†แ…ฉแ†จ แ„‹แ…ฅแ†นแ„‚แ…ณแ†ซ แ„ƒแ…กแ„‹แ…ตแ„‹แ…ฅแ„€แ…ณแ„…แ…ขแ†ท

4. Usage

์ฃผ์š” ๊ธฐ๋Šฅ ์†Œ๊ฐœ

  • Home page แ„‡แ…กแ„แ…ฑแ†ซ homepage
    ๋ฉ”์ธ ํŽ˜์ด์ง€์—์„œ ์ธ๊ธฐ์žˆ๋Š” ์˜ํ™” ๋ชฉ๋ก์„ ๋ณด์—ฌ์ค๋‹ˆ๋‹ค.
    ์˜ต์…˜(1) ์ƒ๋‹จ์˜ ๋‚ด๋น„๊ฒŒ์ด์…˜ ๋ฐ”์—์„œ 5๊ฐ€์ง€ ์žฅ๋ฅด ์ค‘ ๋ง˜์— ๋“œ๋Š” ์žฅ๋ฅด๋ฅผ ์„ ํƒํ•ฉ๋‹ˆ๋‹ค.
    ์˜ต์…˜(2) ๋‚ด๋น„๊ฒŒ์ด์…˜ ๋ฐ” ์šฐ์ธก ์ƒ๋‹จ์˜ ๋กœ๊ทธ์ธ ๋ฐ ํšŒ์›๊ฐ€์ž… ๋ฒ„ํŠผ์œผ๋กœ WATCHVIE์— ์‚ฌ์šฉ์ž ์ •๋ณด๋ฅผ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
    ์˜ต์…˜(3) ์ƒ๋‹จ์˜ ๋‚ด๋น„๊ฒŒ์ด์…˜ ๋ฐ” ์ขŒ์ธก์˜ ํŒ€ ๋กœ๊ณ ์ธ WATCHVIE๋ฅผ ๋ˆ„๋ฅด๋ฉด ์–ด๋–ค ํ™”๋ฉด์— ์žˆ๋˜์ง€ ๋ฉ”์ธ์œผ๋กœ ๋Œ์•„๊ฐ‘๋‹ˆ๋‹ค.
    ์˜ต์…˜(4) ์˜ํ™”์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๊ฒ€์ƒ‰ํ•˜์—ฌ ํ™•์ธํ•ด๋ณผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

  • ๋กœ๊ทธ์ธ๋œ ์ƒํƒœ แ„…แ…ฉแ„€แ…ณแ„‹แ…ตแ†ซแ„’แ…กแ†ซ แ„’แ…ฉแ†ทแ„‘แ…ฆแ„‹แ…ตแ„Œแ…ต
    ๋กœ๊ทธ์ธ ํ›„ ๋ฉ”์ธํ™”๋ฉด์ž…๋‹ˆ๋‹ค. ๋‚ด๋น„๊ฒŒ์ด์…˜ ๋ฐ” ์šฐ์ธก ์ƒ๋‹จ์˜ ๋กœ๊ทธ์•„์›ƒ ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅด๋ฉด ์•ž์„  ํ™ˆํ™”๋ฉด์˜ ํ˜•ํƒœ๋กœ ๋Œ์•„๊ฐ‘๋‹ˆ๋‹ค.

  • SignUp page signuppage
    homepage์—์„œ ์˜ต์…˜(2)์˜ SingUp๋ฒ„ํŠผ์„ ๋ˆ„๋ฅด๋ฉด ์œ„ ํ™”๋ฉด์œผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.
    ์ด๋ฉ”์ผ,์ด๋ฆ„,ID,PW(password)๋ฅผ ์ž…๋ ฅํ•˜์—ฌ ํšŒ์›๊ฐ€์ž… ์ ˆ์ฐจ๋ฅผ ์ง„ํ–‰ํ•ฉ๋‹ˆ๋‹ค.
    ํ™”๋ฉด ํ•˜๋‹จ์˜ SignUp ๋ฒ„ํŠผ์„ ๋ˆ„๋ฅด๋ฉด SignIn page๋กœ ๋„˜์–ด๊ฐ‘๋‹ˆ๋‹ค.

  • SignIn page loginpage
    homepage์—์„œ ์˜ต์…˜(2)์˜ SignIn๋ฒ„ํŠผ์„ ๋ˆ„๋ฅด๋ฉด ์œ„ ํ™”๋ฉด์œผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.
    UserID์™€ PW๋ฅผ ์ž…๋ ฅํ•˜๊ณ  ํ•˜๋‹จ์˜ SignIn ๋ฒ„ํŠผ์„ ๋ˆŒ๋Ÿฌ ํŽ˜์ด์ง€์— ๋กœ๊ทธ์ธํ•ฉ๋‹ˆ๋‹ค.

5. Roadmap

Frontend

1๏ธโƒฃ ์žฅ๋ฅด ์„ ํƒ ๋ฐ ๋กœ๊ทธ์ธ/ํšŒ์›๊ฐ€์ž…์œผ๋กœ ๊ตฌ์„ฑ๋œ ํ—ค๋” ๊ตฌํ˜„

2๏ธโƒฃ ๋กœ๊ทธ์ธ, ํšŒ์›๊ฐ€์ž…, ์˜ํ™” ์ •๋ณด ๋“ฑ ๋‹จ์ผ ํŽ˜์ด์ง€ ๊ตฌ์„ฑ

3๏ธโƒฃ ๊ฐ ํŽ˜์ด์ง€๋“ค ๋ผ์šฐํŒ…

4๏ธโƒฃ ์˜ํ™” API ์—ฐ๊ฒฐ

5๏ธโƒฃ ํšŒ์›๊ฐ€์ž…, ๋กœ๊ทธ์ธ API ์—ฐ๊ฒฐ

6๏ธโƒฃ ๋ฆฌํŒฉํ† ๋ง

7๏ธโƒฃ AWS ๋ฐฐํฌ

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

  • Library

8. Convention

Commit Convention

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-client is licensed under the MIT License

About

KHU Open Source Movie Client ๐ŸŽฌ

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published