Giter VIP home page Giter VIP logo

realworld-mnj's Introduction

Realworld-MNJ

2023 YOURSSU Realworld Project - Merry & Nlog & Juun

๐Ÿ„๐Ÿปโ€โ™‚๏ธ Collaborators

๐Ÿ“„ Document

Swagger: https://api.realworld.io/api-docs/

FE Specs: https://realworld-docs.netlify.app/docs/specs/frontend-specs/templates

๋ฐ๋ชจ ์•ฑ: https://demo.realworld.io

realworld ๊นƒํ—™: https://github.com/gothinkster/realworld

๐Ÿ Commit Convention

Header ๊ธฐ๋Šฅ
feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
fix ๋ฒ„๊ทธ ์ˆ˜์ •
docs ๋ฌธ์„œ ๊ด€๋ จ
style ์Šคํƒ€์ผ ๋ณ€๊ฒฝ (ํฌ๋งคํŒ… ์ˆ˜์ •, ๋“ค์—ฌ์“ฐ๊ธฐ ์ถ”๊ฐ€, โ€ฆ)
refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
test ํ…Œ์ŠคํŠธ ๊ด€๋ จ ์ฝ”๋“œ
build ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •
ci CI ์„ค์ • ํŒŒ์ผ ์ˆ˜์ •
perf ์„ฑ๋Šฅ ๊ฐœ์„ 
chore ๊ทธ ์™ธ ์ž์ž˜ํ•œ ์ˆ˜์ •

๐Ÿชต Branch Convention

Name ๊ธฐ๋Šฅ
main ๊ธฐ์ค€์ด ๋˜๋Š” ๋ธŒ๋žœ์น˜๋กœ ์ œํ’ˆ์„ ๋ฐฐํฌํ•˜๋Š” ๋ธŒ๋žœ์น˜
develop ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜๋กœ ๊ฐœ๋ฐœ์ž๋“ค์ด ์ด ๋ธŒ๋žœ์น˜๋ฅผ ๊ธฐ์ค€์œผ๋กœ ๊ฐ์ž ์ž‘์—…ํ•œ ๊ธฐ๋Šฅ๋“ค์„ ํ•ฉ(Merge)์น˜๋Š” ๋ธŒ๋žœ์น˜ (default)
feature ๋‹จ์œ„ ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜
release ๋ฐฐํฌ๋ฅผ ์œ„ํ•ด master ๋ธŒ๋žœ์น˜๋กœ ๋ณด๋‚ด๊ธฐ ์ „์— ๋จผ์ € QA(ํ’ˆ์งˆ๊ฒ€์‚ฌ)๋ฅผ ํ•˜๊ธฐ์œ„ํ•œ ๋ธŒ๋žœ์น˜
hotfix master ๋ธŒ๋žœ์น˜๋กœ ๋ฐฐํฌ๋ฅผ ํ–ˆ๋Š”๋ฐ ๋ฒ„๊ทธ๊ฐ€ ์ƒ๊ฒผ์„ ๋•Œ ๊ธด๊ธ‰ ์ˆ˜์ •ํ•˜๋Š” ๋ธŒ๋žœ์น˜

realworld-mnj's People

Contributors

yoo-jimin127 avatar 2wndrhs avatar nnnlog avatar

Stargazers

Chaeyeon Seo avatar  avatar  avatar Inkyu Oh avatar

Watchers

Inkyu Oh avatar  avatar

realworld-mnj's Issues

feat: Edit Article ๊ธฐ๋Šฅ

Edit Article ๊ธฐ๋Šฅ

  • Create Article Form๊ณผ ๋™์ผ
    • ํผ ๋‚ด๋ถ€ ๋‚ด์šฉ
      • ์•„ํ‹ฐํด ์ œ๋ชฉ ( ์ œ๋ชฉ ์œ ํšจ์„ฑ โ†’ โ€˜title must be uniqueโ€™)
      • ์•„ํ‹ฐํด ์„ค๋ช… (๋ฏธ์ž…๋ ฅ์‹œ โ†’ โ€˜description can't be blankโ€™)
      • ์•„ํ‹ฐํด ์ž‘์„ฑ (๋ฏธ์ž…๋ ฅ์‹œ โ†’ โ€˜body can't be blankโ€™)
      • ํƒœ๊ทธ, ์ƒ์„ฑ ๋ฒ„ํŠผ (๋ฏธ์ž…๋ ฅ์‹œ โ†’ ์•„ํ‹ฐํด ์ƒ์„ฑ์— ๋ฌธ์ œ X, ์ •์ƒ ์—…๋กœ๋“œ)
      • ๊ธ€ ์ž‘์„ฑ ๋ถ€๋ถ„ : ASCII ์ฝ”๋“œ๊ฐ€ ์•„๋‹ ๊ฒฝ์šฐ ๊ณต๋ฐฑ์œผ๋กœ ๋ฐ”๊ฟ”๋ฒ„๋ ค์„œ ํ•œ๊ธ€๋งŒ ์ž‘์„ฑ๋œ ๋ฌธ์ž๋Š” ํ•˜๋‚˜๋„ ๋‚จ๊ฒจ์ ธ์žˆ์ง€ ์•Š๋„๋ก ๋˜์–ด์žˆ์Œ
  • ๊ธ€ ๋‚ด์šฉ : markdown ํŒŒ์‹ฑ๋˜์–ด์„œ ๋ณด์—ฌ์ง€๋„๋ก
  • ๋ณ€๊ฒฝ ์‚ฌํ•ญ ์—†์ด๋„ ๊ทธ๋Œ€๋กœ ์ž‘์„ฑ ๊ฐ€๋Šฅ
  • ๋‚ด์šฉ ๋ชจ๋‘ ์ง€์šฐ๊ณ  ์ €์žฅ โ†’ ๋ณ€๊ฒฝ ์ด์ „ ๋‚ด์šฉ์ด ๊ทธ๋Œ€๋กœ ํ‘œ์‹œ

feat: Create Article ๊ธฐ๋Šฅ

Create Article Form

  • ํผ ๋‚ด๋ถ€ ๋‚ด์šฉ
    • ์•„ํ‹ฐํด ์ œ๋ชฉ ( ์ œ๋ชฉ ์œ ํšจ์„ฑ โ†’ โ€˜title must be uniqueโ€™)
    • ์•„ํ‹ฐํด ์„ค๋ช… (๋ฏธ์ž…๋ ฅ์‹œ โ†’ โ€˜description can't be blankโ€™)
    • ์•„ํ‹ฐํด ์ž‘์„ฑ (๋ฏธ์ž…๋ ฅ์‹œ โ†’ โ€˜body can't be blankโ€™)
    • ํƒœ๊ทธ, ์ƒ์„ฑ ๋ฒ„ํŠผ (๋ฏธ์ž…๋ ฅ์‹œ โ†’ ์•„ํ‹ฐํด ์ƒ์„ฑ์— ๋ฌธ์ œ X, ์ •์ƒ ์—…๋กœ๋“œ)
    • ๊ธ€ ์ž‘์„ฑ ๋ถ€๋ถ„ : ASCII ์ฝ”๋“œ๊ฐ€ ์•„๋‹ ๊ฒฝ์šฐ ๊ณต๋ฐฑ์œผ๋กœ ๋ฐ”๊ฟ”๋ฒ„๋ ค์„œ ํ•œ๊ธ€๋งŒ ์ž‘์„ฑ๋œ ๋ฌธ์ž๋Š” ํ•˜๋‚˜๋„ ๋‚จ๊ฒจ์ ธ์žˆ์ง€ ์•Š๋„๋ก ๋˜์–ด์žˆ์Œ
  • ๊ธ€ ๋‚ด์šฉ : markdown ํŒŒ์‹ฑ๋˜์–ด์„œ ๋ณด์—ฌ์ง€๋„๋ก

feat: Home ๊ธฐ๋Šฅ

Home ๊ธฐ๋Šฅ

  • ๊ณตํ†ต ๊ธฐ๋Šฅ
    • Global Feed : ๊ณตํ†ต
    • Popular Tags ์š”์†Œ ํด๋ฆญ ์‹œ, #tags ์ด๋ฆ„์œผ๋กœ ํƒญ์ด ์ƒ๊ฒจ๋‚จ
  • ๋กœ๊ทธ์ธ O
    • ์ข‹์•„์š” ๊ธฐ๋Šฅ (ํšŒ์›์ผ ๋•Œ๋งŒ ์‚ฌ์šฉ ๊ฐ€๋Šฅ)
    • Your Feed : ๋กœ๊ทธ์ธ์ด ๋˜์–ด์žˆ์„ ๋•Œ ์กฐ๊ฑด๋ถ€ ๋ Œ๋”๋ง
      • ํŒ”๋กœ์šฐ ํ•œ ์‚ฌ๋žŒ๋“ค์˜ ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
    • Global Feed ํƒญ
      • ๋ชจ๋“  ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
  • ๋กœ๊ทธ์ธ X
    • Global Feed ํƒญ
      • ๋ชจ๋“  ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
  • ํŽ˜์ด์ง€๋„ค์ด์…˜

feat: Header ๊ธฐ๋Šฅ

Header ๊ธฐ๋Šฅ

  • ๋กœ๊ณ  ํด๋ฆญ ์‹œ Home์œผ๋กœ ์ด๋™ (๋กœ๊ทธ์ธ ์—ฌ๋ถ€ ์ƒ๊ด€ X)
  • ๋กœ๊ทธ์ธ O
    • Home
    • New article
    • Settings
    • Profile
  • ๋กœ๊ทธ์ธ X
    • Home
    • Sign In
    • Sign Up

feat: Login/Register ๊ธฐ๋Šฅ

Login/Register ๊ธฐ๋Šฅ

  • Sign In
    • ๋กœ๊ทธ์ธ ํผ
      • user email, password, button
  • Sign Up
    • ํšŒ์›๊ฐ€์ž… ํผ
      • username, email, password ์ž…๋ ฅ
      • ์œ ํšจ์„ฑ

feat: Profile ๊ธฐ๋Šฅ

Profile ๊ธฐ๋Šฅ

  • ์ž์‹ ์˜ ํ”„๋กœํ•„ ํŽ˜์ด์ง€
    • ํ”„๋กœํ•„ ๋ฐฐ๋„ˆ
      • ํ”„๋กœํ•„ ์‚ฌ์ง„, ์œ ์ € ์ด๋ฆ„ ํ‘œ์‹œ
      • ํ”„๋กœํ•„ ํŽธ์ง‘ ํŽ˜์ด์ง€๋กœ ์ด๋™ํ•˜๋Š” ๋ฒ„ํŠผ
    • ํ”„๋กœํ•„ ํŽธ์ง‘ ํŽ˜์ด์ง€
      • ํ”„๋กœํ•„ ์‚ฌ์ง„ URL, ์œ ์ € ์ด๋ฆ„, ๊ฐ„๋‹จํ•œ ์†Œ๊ฐœ, ์ด๋ฉ”์ผ, ์ƒˆ๋กœ์šด ๋น„๋ฐ€๋ฒˆํ˜ธ ์ž…๋ ฅ
      • ํ”„๋กœํ•„ ์—…๋ฐ์ดํŠธ ๊ธฐ๋Šฅ
      • ๋กœ๊ทธ์•„์›ƒ ๊ธฐ๋Šฅ
    • My Article ํƒญ
      • ์ž์‹ ์ด ์ž‘์„ฑํ•œ ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
    • Favorited Articles ํƒญ
      • ์ข‹์•„์š”๋ฅผ ๋ˆ„๋ฅธ ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
  • ํƒ€์ธ์˜ ํ”„๋กœํ•„ ํŽ˜์ด์ง€
    • ํ”„๋กœํ•„ ๋ฐฐ๋„ˆ
      • ํ•ด๋‹น ์œ ์ €์˜ ํ”„๋กœํ•„ ์‚ฌ์ง„, ์œ ์ € ์ด๋ฆ„ ํ‘œ์‹œ
      • ํ•ด๋‹น ์œ ์ € ํŒ”๋กœ์šฐ ๋ฒ„ํŠผ
    • My Article ํƒญ
      • ํ•ด๋‹น ์œ ์ €๊ฐ€ ์ž‘์„ฑํ•œ ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ
    • Favorited Articles ํƒญ
      • ํ•ด๋‹น ์œ ์ €๊ฐ€ ์ข‹์•„์š”๋ฅผ ๋ˆ„๋ฅธ ๊ฒŒ์‹œ๊ธ€ ํ‘œ์‹œ

feat: Article ๊ธฐ๋Šฅ

Article ๊ธฐ๋Šฅ

  • ์ž‘์„ฑํ•œ ๋‚ด์šฉ ๋ณด์—ฌ์ฃผ๋Š” ๊ธฐ๋Šฅ
  • ํ”„๋กœํ•„ ์ •๋ณด + ๊ธ€ ์ž‘์„ฑ ์ผ์ž
  • ์ž‘์„ฑ์ž ํŒ”๋กœ์šฐ ๋ฒ„ํŠผ (๋กœ์ง)
  • ๊ฒŒ์‹œ๋ฌผ ์ข‹์•„์š” ๋ฒ„ํŠผ (๋กœ์ง)
  • ๋Œ“๊ธ€ ์ž‘์„ฑ (๋กœ์ง)
  • ๋ณธ์ธ ์ž‘์„ฑ ๊ฒŒ์‹œ๊ธ€
    • ์ œ๋ชฉ์ด ํ‘œ์‹œ๋˜๋Š” ๋ฐฐ๋„ˆ
      • Edit Article
      • Delete Article
    • ์ž‘์„ฑํ•œ ๊ธ€ ๋ณด์—ฌ์ง€๋Š” ๋ถ€๋ถ„
    • ํ”„๋กœํ•„ ์ •๋ณด + Edit, Delete ๋ฒ„ํŠผ
    • ๋Œ“๊ธ€ ์ž‘์„ฑ ๋ถ€๋ถ„
  • ํƒ€์ธ ์ž‘์„ฑ ๊ฒŒ์‹œ๊ธ€
    • ์ œ๋ชฉ์ด ํ‘œ์‹œ๋˜๋Š” ๋ฐฐ๋„ˆ
      • Follow ๋ฒ„ํŠผ
      • ์ข‹์•„์š” ๋ฒ„ํŠผ
    • ์ž‘์„ฑํ•œ ๊ธ€ ๋ณด์—ฌ์ง€๋Š” ๋ถ€๋ถ„
    • ํ”„๋กœํ•„ ์ •๋ณด + Follow, ์ข‹์•„์š” ๋ฒ„ํŠผ
    • ๋Œ“๊ธ€ ์ž‘์„ฑ ๋ถ€๋ถ„

feat: Settings ๊ธฐ๋Šฅ

Settings ๊ธฐ๋Šฅ

  • ์œ ์ € ์ •๋ณด
    • bio/email/username, image(url) ์กฐํšŒ, ๋ณ€๊ฒฝ ๊ฐ€๋Šฅ
    • password ๋ณ€๊ฒฝ ๊ฐ€๋Šฅ
    • field ๋น„์›Œ๋‘”๊ฑฐ ๋”ฐ๋กœ validation ์•ˆ ํ•ด๋„ ๋จ
  • ๋กœ๊ทธ์•„์›ƒ ๋ฒ„ํŠผ
    • localstorage์˜ JWT ์ง€์›€

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.