Skip to content

๐Ÿ‘Š README.md ์ž‘์„ฑ๋ฒ•์ž…๋‹ˆ๋‹ค.(ํ”„๋ก ํŠธ์—”๋“œ, ๋ฐฑ์—”๋“œ, ์›น๊ธฐ์ดˆํŒ€ ๋ชจ๋‘ ๋‹ค ์ฝ์–ด์ฃผ์„ธ์š”!)

Notifications You must be signed in to change notification settings

Coding-Stage-Web/notice-README.md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 

Repository files navigation

README.md ์ž‘์„ฑํ•˜๊ธฐ

๊ณผ์ œ ์ž‘์„ฑ ํŽ˜์ด์ง€

๐Ÿ’™ README.md

โœจ๋•ก๋•กํŒŒํŠธ ์ฝ”์Šทํ…Œโœจ

๐Ÿ’ป ๊ณผ์ œ

week ๊ณผ์ œ์ฃผ์ œ ๊ณผ์ œ๋งํฌ(week๋ธŒ๋žœ์น˜๋งํฌ์ฒจ๋ถ€)
1์ฃผ์ฐจ spring mvc ์•„ํ‚คํ…์ณ ๋งํฌ1
2์ฃผ์ฐจ typescriprt ๋งํฌ2
3์ฃผ์ฐจ styled-component ๋งํฌ3
4์ฃผ์ฐจ FAST API ๋งํฌ4
5์ฃผ์ฐจ jquery ๋งํฌ5
6์ฃผ์ฐจ java servelet ๋งํฌ6
7์ฃผ์ฐจ usestate์™€ useffect ๋งํฌ7
8์ฃผ์ฐจ ํ”„๋กœํ† ์ฝœ ๋งํฌ8

ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ ํŽ˜์ด์ง€

์ „์ฒด ๐Ÿ’™ README.md

<img src="์—ฌ๋Ÿฌ๋ถ„์˜ ์„œ๋น„์Šค ์†Œ๊ฐœ ์ฒซํŽ˜์ด์ง€ ํ™”๋ฉด">

์„œ๋น„์Šค๋ฅผ ์†Œ๊ฐœํ•ด์ฃผ์„ธ์š”.โœจโœจ

๋ฐœํ‘œํ•˜๋ฉด์„œ ๋งŒ๋“  ํ”ผํ”ผํ‹ฐ์˜ ๊ธฐ๋Šฅ ์†Œ๊ฐœ ํŽ˜์ด์ง€๋ฅผ ์—ฌ๊ธฐ์— ํ•˜๋‚˜ํ•˜๋‚˜ ์—…๋กœ๋“œํ•ด์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

Client&Server ๋ฆฌํฌ์ง€ํ† ๋ฆฌ์˜ ๐Ÿ’™ README.md (๊ฐ๊ฐ์˜ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ ์•ˆ์— ์ž‘์„ฑํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค! )

๐Ÿ™ŒํŒ€์› ์†Œ๊ฐœ

๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ
๐Ÿงš๐ŸปWeb FE ๐Ÿ‘ผWeb FE ๐Ÿ‘ผWeb FE ๐Ÿ˜ฝWeb FE

Tech Stack

image

** ์˜ˆ์‹œ์ž…๋‹ˆ๋‹ค.

๐Ÿ“‚Directory Structure

ํด๋” ๊ตฌ์กฐ์™€ ํด๋” ์„ค๋ช… ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

๐Ÿ’™CodingStage-Client
โ”ฃ ๐Ÿ“‚.github //์ด์Šˆ,PR ํ…œํ”Œ๋ฆฟ ๋“ฑ ๊นƒํ—ˆ๋ธŒ ๊ด€๋ จ ํŒŒ์ผ ๊ด€๋ฆฌ
โ”ฃ ๐Ÿ“‚.next
โ”ฃ ๐Ÿ“‚.vscode
โ”ฃ ๐Ÿ“‚.yarn
โ”ฃ ๐Ÿ“‚api //axios ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ๊ธฐ๋ฐ˜์œผ๋กœ ๋น„๋™๊ธฐ ํ†ต์‹ ํ•˜๋Š” ํ•จ์ˆ˜๋“ค, axios instance ํŒŒ์ผ๋กœ ๊ตฌ    ์„ฑ
โ”ฃ ๐Ÿ“‚apiHooks //api์˜ ํ•จ์ˆ˜๋“ค์„ ์ด์šฉํ•˜์—ฌ react-query๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋Š” ํ•จ์ˆ˜๋“ค๋กœ ๊ตฌ์„ฑ
โ”ฃ ๐Ÿ“‚components //ํŽ˜์ด์ง€๋ฅผ ๊ตฌ์„ฑํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ๋“ค๋กœ ๊ตฌ์„ฑ
โ”ƒ โ”ฃ ๐Ÿ“‚common // ๊ณตํ†ต์ ์œผ๋กœ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ
โ”ƒ โ”ฃ ๐Ÿ“‚handleinfo // ์ „ํ™”๋ฒˆํ˜ธ, ๋ฐฐ์†ก์ง€ ์ตœ์ดˆ๋“ฑ๋ก ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ 
โ”ƒ โ”ฃ ๐Ÿ“‚layout // app.tsx์—์„œ ์‚ฌ์šฉํ•˜๋Š” ๋ ˆ์ด์•„์›ƒ ์ปดํฌ๋„ŒํŠธ
โ”ƒ โ”ฃ ๐Ÿ“‚matching // ๋งค์นญ์ค‘/๋งค์นญ์™„๋ฃŒ ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ
โ”ƒ โ”ฃ ๐Ÿ“‚myBuy // ๋‚ดํŒ๋งค ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ 
โ”ƒ โ”ฃ ๐Ÿ“‚myInfo // ๋‚ด์ •๋ณด ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ 
โ”ƒ โ”ฃ ๐Ÿ“‚mySell // ๋‚ด๊ตฌ๋งค ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ 
โ”ƒ โ”ฃ ๐Ÿ“‚offer // ๊ฐ€๊ฒฉ ์ œ์‹œ ๋ฐ ๊ตฌ๋งค ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ
โ”ƒ โ”ฃ ๐Ÿ“‚profile // ์œ ์ € ์ •๋ณด๋ฅผ ๋ถˆ๋Ÿฌ์˜ค๋Š” ์ปดํฌ๋„ŒํŠธ
โ”ƒ โ”ฃ ๐Ÿ“‚sell // ํŒ๋งค๊ธ€ ๊ด€๋ จ ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ 
โ”ƒ โ”ฃ ๐Ÿ“‚suggests // ๊ตฌ๋งค ์ œ์•ˆ ๋ชฉ๋ก ํŽ˜์ด์ง€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ  
โ”ƒ โ”— ๐Ÿ“œindex.d.ts // .git export๋ฅผ ์œ„ํ•œ ํŒŒ์ผ
โ”ฃ ๐Ÿ“‚constants // ํ™˜๊ฒฝ๋ณ€์ˆ˜ ๋ฐ ์ƒ์ˆ˜ ํŒŒ์ผ์„ ์ €์žฅํ•˜๋Š” ํด๋”
โ”ฃ ๐Ÿ“‚hooks // ๋ฆฌ์•กํŠธ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ์ž์ฃผ ์‚ฌ์šฉ๋˜๋Š” ์ปค์Šคํ…€ ํ›…๋“ค๋กœ ๊ตฌ์„ฑ
โ”ฃ ๐Ÿ“‚mocks // msw๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ํ†ตํ•œ ์„œ๋ฒ„ ๋ชจํ‚น์„ ์œ„ํ•œ ํŒŒ์ผ๋“ค๋กœ ๊ตฌ์„ฑ
โ”ฃ ๐Ÿ“‚pages // ํŽ˜์ด์ง€ ์ปดํฌ๋„ŒํŠธ๋“ค๋กœ ๊ตฌ์„ฑ
โ”ƒ โ”ฃ ๐Ÿ“‚handleinfo
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œadddelivery.tsx // ์ „ํ™”๋ฒˆํ˜ธ ์ตœ์ดˆ๋“ฑ๋ก
โ”ƒ โ”ƒ โ”— ๐Ÿ“œaddphonenumber.tsx // ๋ฐฐ์†ก์ง€ ์ตœ์ดˆ๋“ฑ๋ก
โ”ƒ โ”ฃ ๐Ÿ“‚login
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œcheck.tsx // ๋กœ๊ทธ์ธ ์„ฑ๊ณต ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”— ๐Ÿ“œindex.tsx // ๋กœ๊ทธ์ธ ์š”์ฒญ ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚matching
โ”ƒ โ”— ๐Ÿ“œ[id].tsx // '๋งค์นญ ์ค‘์ธ ๋ชฉ๋ก','๋งค์นญ ์™„๋ฃŒ ๋ชฉ๋ก ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚my // GNB ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œalarm.tsx // ๋‚ด์•Œ๋žŒ ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œbuy.tsx // ๋‚ด๊ตฌ๋งค ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œinfo.tsx // ๋‚ด์ •๋ณด ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œinfoFix.tsx // ๋‚ด์ •๋ณด ์ˆ˜์ • ํŽ˜์ด์ง€
โ”ƒ โ”ƒ โ”— ๐Ÿ“œsell.tsx // ๋‚ดํŒ๋งค ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚offer //  ๊ฐ€๊ฒฉ ์ œ์‹œ ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚profile // ์œ ์ € ์ •๋ณด ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚sell // ํŒ๋งค๊ธ€ ๊ด€๋ จ ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“‚suggests // ๊ตฌ๋งค ์ œ์•ˆ ๋ชฉ๋ก ํŽ˜์ด์ง€
โ”ƒ โ”ฃ ๐Ÿ“œ_app.tsx
โ”ƒ โ”ฃ ๐Ÿ“œ_document.tsx
โ”ƒ โ”— ๐Ÿ“œindex.tsx
โ”ฃ ๐Ÿ“‚public // ์ •์  ์ด๋ฏธ์ง€ ์—์…‹๋“ค์„ ์ €์žฅํ•˜๋Š” ํด๋”
โ”ฃ ๐Ÿ“‚recoil // recoil๋กœ ๊ด€๋ฆฌํ•  ์ƒํƒœ๋กœ ๊ตฌ์„ฑ
โ”ฃ ๐Ÿ“‚styles // ์ „์—ญ ์Šคํƒ€์ผ ๋ฐ ์—ฌ๋Ÿฌ ์ปดํฌ๋„ŒํŠธ์—์„œ ๊ณต์œ ํ•˜๋Š” ์Šคํƒ€์ผ ํŒŒ์ผ์„ ์ €์žฅํ•˜๋Š” ํด๋”
โ”ƒ โ”ฃ ๐Ÿ“œglobalStyle.ts
โ”ƒ โ”— ๐Ÿ“œtheme.ts
โ”ฃ ๐Ÿ“‚types // ์—ฌ๋Ÿฌ ์ปดํฌ๋„ŒํŠธ์—์„œ ๊ณตํ†ต์ ์œผ๋กœ ์‚ฌ์šฉ๋˜๋Š” ํƒ€์ž…๋“ค๋กœ ๊ตฌ์„ฑ
โ”ƒ โ”ฃ ๐Ÿ“‚axios // ์ •์  ์ด๋ฏธ์ง€ ์—์…‹๋“ค์„ ์ €์žฅํ•˜๋Š” ํด๋”
โ”ƒ โ”ฃ ๐Ÿ“‚recoil // recoil๋กœ ๊ด€๋ฆฌํ•  ์ƒํƒœ๋กœ ๊ตฌ์„ฑ
โ”ƒ โ”ฃ ๐Ÿ“œcontainer.ts // children interface ํƒ€์ž… ์ง€์ •
โ”ƒ โ”— ๐Ÿ“œpage.d.ts // AppLayout ํƒ€์ž… ์ง€์ •
โ”ฃ ๐Ÿ“‚utils //์—ฌ๋Ÿฌ ์ปดํฌ๋„ŒํŠธ์—์„œ ์‚ฌ์šฉ๋˜๋Š” ์œ ํ‹ธํ•จ์ˆ˜๋“ค๋กœ ๊ตฌ์„ฑ
โ”ƒ โ”— ๐Ÿ“œprice.ts // ๊ฐ€๊ฒฉ์— 1000๋‹จ์œ„๋งˆ๋‹ค ,(์ฝค๋งˆ) ์ฐํžˆ๋„๋กํ•˜๋Š” ์œ ํ‹ธํ•จ์ˆ˜
โ”ฃ ๐Ÿ“œ.babelrc
โ”ฃ ๐Ÿ“œ.eslintrc.json
โ”ฃ ๐Ÿ“œ.gitignore
โ”ฃ ๐Ÿ“œ.pnp.cjs
โ”ฃ ๐Ÿ“œ.pnp.loader.mjs
โ”ฃ ๐Ÿ“œ.prettierrc
โ”ฃ ๐Ÿ“œ.yarnrc.yml
โ”ฃ ๐Ÿ“œREADME.md
โ”ฃ ๐Ÿ“œnext-env.d.ts
โ”ฃ ๐Ÿ“œnext.config.js
โ”ฃ ๐Ÿ“œpackage.json
โ”ฃ ๐Ÿ“œtsconfig.json
โ”— ๐Ÿ“œyarn.lock

** ์ด๊ฑธ ์–ด๋–ป๊ฒŒ ํ•˜๋‚˜ํ•˜๋‚˜ ๋‹ค ์ž‘์„ฑํ•˜๋ƒ๊ตฌ์š”...? ์ €๋„ ํ–ˆ์œผ๋‹ˆ ์—ฌ๋Ÿฌ๋ถ„๋„ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค^^ (ํž˜๋“ค์–ด ์ฃฝ์„๊ฑฐ๊ฐ™์•„์š”....)

๐Ÿค Dependencies

 
  "dependencies": {
    "@tanstack/react-query": "^4.20.4",
    "@testing-library/jest-dom": "^5.14.1",
    "@testing-library/react": "^13.0.0",
    "@testing-library/user-event": "^13.2.1",
    "@types/jest": "^29.2.4",
    "@types/react-dom": "^18.0.9",
    "axios": "^1.2.1",
    "next": "12",
    "react": "^18.2.0",
    "react-daum-postcode": "^3.1.1",
    "react-dom": "^18.2.0",
    "react-is": "^18.2.0",
    "react-slick": "^0.29.0",
    "recoil": "^0.7.6",
    "slick-carousel": "^1.8.1",
    "styled-components": "^5.3.6",
    "styled-reset": "^4.4.4",
    "supports-color": "^9.3.1",
    "typescript": "^4.9.4",
    "web-vitals": "^2.1.0"
  },
  "devDependencies": {
   "@svgr/webpack": "^6.5.1",
    "@types/eslint": "^8",
    "@types/node": "^18.11.17",
    "@types/prettier": "^2",
    "@types/react": "^18",
    "@types/react-slick": "^0.23.10",
    "@types/slick-carousel": "^1",
    "@types/styled-components": "^5.1.26",
    "@typescript-eslint/eslint-plugin": "^5.47.0",
    "@typescript-eslint/parser": "^5.47.0",
    "@yarnpkg/sdks": "^3.0.0-rc.34",
    "babel-plugin-styled-components": "^2.0.7",
    "eslint": "^8.30.0",
    "eslint-config-prettier": "^8.5.0",
    "eslint-plugin-import": "^2.26.0",
    "eslint-plugin-jsx-a11y": "^6.6.1",
    "eslint-plugin-prettier": "^4.2.1",
    "eslint-plugin-react": "^7.31.11",
    "eslint-plugin-react-hooks": "^4.6.0",
    "prettier": "^2.8.1"
  }


โญ๏ธํ•ต์‹ฌ ๊ธฐ๋Šฅ ๊ตฌํ˜„

๋…ธ์…˜์‚ฌ์ดํŠธ ๋ฐ”๋กœ๊ฐ€๊ธฐ or ์ถ”๊ฐ€ ์„ค๋ช… ๋ฐ ๊ธฐ๋Šฅ ์•„ํ‚คํ…์ฒ˜ ์œ ์•„์ด ์ฒจ๋ถ€

์›น๊ธฐ์ดˆ์˜ ๐Ÿ’™ README.md

๐Ÿ™ŒํŒ€์› ์†Œ๊ฐœ

๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ ๋ณธ์ธ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ๋Š” ์‚ฌ์ง„๊ณผ ๊นƒํ—™ ๋งํฌ
๐Ÿงš๐ŸปWeb BA ๐Ÿ‘ผWeb BA ๐Ÿ‘ผWeb BA ๐Ÿ˜ฝWeb BA

๐Ÿ“‚Directory Structure

ํด๋” ๊ตฌ์กฐ์™€ ํด๋” ์„ค๋ช… ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.

โญ๏ธํ•ต์‹ฌ ๊ธฐ๋Šฅ

๋…ธ์…˜์‚ฌ์ดํŠธ ๋ฐ”๋กœ๊ฐ€๊ธฐ or ์ถ”๊ฐ€ ์„ค๋ช… ๋ฐ ๊ธฐ๋Šฅ ์•„ํ‚คํ…์ฒ˜ ์œ ์•„์ด ์ฒจ๋ถ€

About

๐Ÿ‘Š README.md ์ž‘์„ฑ๋ฒ•์ž…๋‹ˆ๋‹ค.(ํ”„๋ก ํŠธ์—”๋“œ, ๋ฐฑ์—”๋“œ, ์›น๊ธฐ์ดˆํŒ€ ๋ชจ๋‘ ๋‹ค ์ฝ์–ด์ฃผ์„ธ์š”!)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published