diff --git a/README.md b/README.md index 2926f6e3..b933668a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,222 @@ -# seb41_main_036 +# ๐Ÿ™Œ Intro +![Logo 1475e3023dc018c33f6a](https://user-images.githubusercontent.com/110949256/216314162-9e0877c9-e842-4ddb-9f27-b6a6f45f1302.png) +- `ํŒ€๋ช…` : ์ฝ”๋“œ์Šคํ…Œ์ด์ธ  41๊ธฐ 36ํŒ€ ์žฅ๊ด€์ด์กฐ +- `ํŒ€์›` : ๊น€์ง„์ฃผ(ํŒ€์žฅ), ์ด๋™์šฐ(์„œ๊ธฐ), ์ •์„ธ๋ฏผ, ์ด์ƒ์œ , ๋ฐ•ํ˜œ์ˆ˜, ์ด์Šนํ˜„ +- `๋„๋ฉ”์ธ` : https://pikcha36.o-r.kr +- `๊ธฐ์ˆ ๋ฐœํ‘œ` : https://youtu.be/cl04jBYgSjI +- `๊ฐœ๋ฐœ๊ธฐ๊ฐ„` : 2023. 1. 3. ~ 2023. 2. 3. (ํ•œ๋‹ฌ๊ฐ„) -### commit convention -- `feat`: A new feature -- `fix`: A bug fix -- `docs`: Changes to documentation -- `style`: Formatting, missing semi colons, etc; no code change -- `refactor`: Refactoring production code -- `test`: Adding tests, refactoring test; no production code change -- `chore`: Updating build tasks, package manager configs, etc; no production code change +
------- -### ๊ธฐ์ˆ  ์Šคํƒ +# ๐Ÿ  About Pikcha +## ๐Ÿ–ผ๏ธ Pikcha(ํ”ฝ์ฐจ)? + + +`Pikcha`๋Š” ์†Œ์ค‘ํ•œ ์‚ฌ๋žŒ๊ณผ ๋‹ค๋…€์˜จ ๊ธฐ๋ก์„ ๊ธฐ์–ตํ•  ์ˆ˜ ์žˆ๋Š” ๊ณต๊ฐ„์ž…๋‹ˆ๋‹ค. + +์‰ฌ๋Š”๋‚  ๊ฐ€์กฑ, ์นœ๊ตฌ ๋˜๋Š” ์—ฐ์ธ๊ณผ ์–ด๋””๋ฅผ ๊ฐ€์•ผํ•  ์ง€ ์ž˜ ๋ชจ๋ฅธ๋‹ค๋ฉด Pikcha๋ฅผ ์ด์šฉํ•ด๋ณด์„ธ์š”! + +## ๐Ÿ‘€ ์™œ ๋งŒ๋“ค์—ˆ์„๊นŒ์š”? + + +`Pikcha`๋Š” ์„œ์šธ ๋‚ด ๋ช…์†Œ๊ฐ€ ์–ด๋””์ธ์ง€ ์ž˜ ๋ชจ๋ฅด๋Š” ๋‹น์‹ ์„ ์œ„ํ•ด ๋งŒ๋“ค์–ด์กŒ์Šต๋‹ˆ๋‹ค. + +์ €ํฌ๊ฐ€ ์„ ๋ณ„ํ•œ ๋ฉ‹์ง€๊ณ  ์•„๋ฆ„๋‹ค์šด ๋‹ค์–‘ํ•œ ๋ช…์†Œ๋“ค์„ ๋ฐฉ๋ฌธํ•ด๋ณด์„ธ์š”. + +## โญ๏ธ ๊ธฐ๋Šฅ + + +`ํฌ์ŠคํŒ…`์„ ํ†ตํ•ด ์ž์‹ ์ด ๋‹ค๋…€์˜จ ๋ช…์†Œ๋ฅผ ๊ณต์œ ํ•˜๊ณ  ์‚ฌ๋ž‘ํ•˜๋Š” ์‚ฌ๋žŒ๋“ค๊ณผ ์†Œํ†ตํ•˜์„ธ์š”. + +๋‹ค๋ฅธ ์‚ฌ๋žŒ๋“ค์ด ์˜ฌ๋ฆฐ ํฌ์ŠคํŒ…์— `์ข‹์•„์š”`๋ฅผ ํ‘œ์‹œํ•ด๋ณด์„ธ์š”. + +๋ฐฉ๋ฌธํ•œ ๋ช…์†Œ๋ฅผ `์ฆ๊ฒจ์ฐพ๊ธฐ`ํ•ด ์†Œ์ค‘ํ•œ ๊ธฐ์–ต์„ ๊ฐ„์งํ•˜์„ธ์š”. + +
+ +# ๐ŸŒˆ Team + +## ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Members + +|๊น€์ง„์ฃผ (ํŒ€์žฅ, FE) |์ •์„ธ๋ฏผ(FE) +:-----------------------------:|:-----------------------------:| +|| +|[@useusername1](https://github.com/useusername1) |[@MINSE97](https://github.com/MINSE97) + +|๋ฐ•ํ˜œ์ˆ˜ (FE) |์ด์Šนํ˜„ (FE) +:-----------------------------:|:-----------------------------:| +|||>| +|[@namnam-5799](https://github.com/namnam-5799) |[@NowVic99](https://github.com/NowVic99) | + +|์ด๋™์šฐ (์„œ๊ธฐ, BE) |์ด์ƒ์œ  (BE) +:-----------------------------:|:-----------------------------:| +|||>| +| [@eastmeet](https://github.com/eastmeet) | [@Sangyoo](https://github.com/Sangyoo) | + +
+ +## ๐Ÿ‘‘ Roles & Responsibility + +| Name | Roles | Responsibility | +---------------------------------|--------------------------------|--------------------------------| +|๊น€์ง„์ฃผ| Frontend | ํ—ค๋”, ๊ฒ€์ƒ‰์ฐฝ ๊ตฌํ˜„, ์บ๋Ÿฌ์…€, ์‹ค์‹œ๊ฐ„ ๋žญํ‚น ๊ตฌํ˜„, ์ข‹์•„์š”, ๋ถ๋งˆํฌ ๊ธฐ๋Šฅ| +|์ •์„ธ๋ฏผ| Frontend | ๋ช…์†Œ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ ๋ฐ ํ•„ํ„ฐ๋ง, ํฌ์ŠคํŠธ ๋ฆฌ์ŠคํŠธ ์กฐํšŒ ๋ฐ ํ•„ํ„ฐ๋ง, ์ƒ์„ธํฌ์ŠคํŠธ CRUD ๊ธฐ๋Šฅ ๊ตฌํ˜„, ์ƒ์„ธํฌ์ŠคํŠธ ๋Œ“๊ธ€ CRUD ๊ธฐ๋Šฅ ๊ตฌํ˜„, ๋งˆ์ดํŽ˜์ด์ง€ ์ •๋ณด CRUD ๊ธฐ๋Šฅ ๊ตฌํ˜„| +|๋ฐ•ํ˜œ์ˆ˜| Frontend | ์ง€๋„ ํŽ˜์ด์ง€ ๊ตฌํ˜„, ๋ช…์†Œ ์ƒ์„ธ ํŽ˜์ด์ง€ ๊ตฌํ˜„ | +|์ด์Šนํ˜„| Frontend | ํšŒ์›๊ฐ€์ž… ๋ฐ ๋กœ๊ทธ์ธ, ์†Œ์…œ ๋กœ๊ทธ์ธ, ๋กœ๊ทธ์•„์›ƒ ํŽ˜์ด์ง€ ๋ฐ ๋กœ์ง, ํ† ํฐ์„ ์ด์šฉํ•œ ํ†ต์‹  ๋กœ์ง ๊ตฌํ˜„ (์žฌ๋ฐœ๊ธ‰ ๋ฐ ์ž๋™ ๋กœ๊ทธ์•„์›ƒ), ์ „์—ญ ์ƒํƒœ ๊ด€๋ฆฌ | +|์ด๋™์šฐ| Backend | ํšŒ์›๊ฐ€์ž… ๋ฐ ๋กœ๊ทธ์ธ, ์†Œ์…œ ๋กœ๊ทธ์ธ, ๋กœ๊ทธ์•„์›ƒ, NginX ์›น์„œ๋ฒ„ ๊ตฌ์ถ•, AWS ๋ฐฐํฌ, SSL ๋ณด์•ˆ, ๋ฉค๋ฒ„ํ”„๋กœํ•„, ๋Œ“๊ธ€ ๋„๋ฉ”์ธ ๊ตฌํ˜„| +|์ด์ƒ์œ | Backend | ๋ช…์†Œ, ํฌ์ŠคํŠธ ๋„๋ฉ”์ธ ๊ตฌํ˜„, S3 ์ด๋ฏธ์ง€ ์—…๋กœ๋“œ, ์ข‹์•„์š”, ์ฆ๊ฒจ์ฐพ๊ธฐ, ํ•„ํ„ฐ๋ง, ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ| + + +
+ +# ๐Ÿ’ผ Document +### [Figma](https://www.figma.com/file/iFs2WMfNlUTOA6ILnCljk3/main-project?node-id=0%3A1&t=54AppbXG2IH2Ven1-1) + +### [UserFlow](https://github.com/codestates-seb/seb41_main_036/wiki/UserFlow) + +### [ERD](https://github.com/codestates-seb/seb41_main_036/wiki/ERD) + +### [API ๋ช…์„ธ](https://documenter.getpostman.com/view/23682192/2s935hQmqG) + +
+ +# ๐Ÿ›ต Development Tools + +
+ +# ๐Ÿ•น๏ธ commit convention + +`feat`: A new feature + +`fix`: A bug fix + +`docs`: Changes to documentation + +`style`: Formatting, missing semi colons, etc; no code change + +`refactor`: Refactoring production code + +`test`: Adding tests, refactoring test; no production code change + + `chore`: Updating build tasks, package manager configs, etc; no production code change + +
+ +# :hamster: Pikcha ํ™œ์šฉ๋ฒ•! + +
+ +## :mushroom: 1. ๋ฉ”์ธ ํŽ˜์ด์ง€ + +
+๋ฉ”์ธ +
+ +|๋ฉ”์ธ ํŽ˜์ด์ง€| +|:---:| +| + +
+
+ +
+
+๋ฉ”์ธ ๋ช…์†Œ & ํฌ์ŠคํŠธ +
+ +|๋ฉ”์ธ ๋ช…์†Œ| ๋ฉ”์ธ ํฌ์ŠคํŠธ | +|:---:|:---:| +|| + +
+
+
+ +## :herb: 2. ํšŒ์› +
+
+ ํšŒ์›๊ฐ€์ž…&๋กœ๊ทธ์ธ +
+ +|ํšŒ์›๊ฐ€์ž… | ๋กœ๊ทธ์ธ | +|:---:|:---:| +|| + +
+
+
+ +## :blossom: 3. ํšŒ์› ์ •๋ณด +
+
+ ๋งˆ์ดํŽ˜์ด์ง€ +
+ +|๋งˆ์ด ํŽ˜์ด์ง€| +|:---:| +| + +
+
+
+ +## :cactus: 4. ๋ช…์†Œ + +
+
+ ๋ช…์†Œ ํŽ˜์ด์ง€ & ๋ช…์†Œ ์ƒ์„ธํŽ˜์ด์ง€ +
+ +|๋ช…์†Œ ํŽ˜์ด์ง€| ๋ช…์†Œ ์ƒ์„ธํŽ˜์ด์ง€ | +|:---:|:---:| +|| + +
+
+ +
+
+ ๋ช…์†Œ ๊ฒ€์ƒ‰ & ์ข‹์•„์š” & ์ฆ๊ฒจ์ฐพ๊ธฐ +
+ +|๋ช…์†Œ ๊ฒ€์ƒ‰| ๋ช…์†Œ ์ข‹์•„์š”, ์ฆ๊ฒจ์ฐพ๊ธฐ| +|:---:|:---:| +||| + +
+
+
+ +## :speech_balloon: 5. ํฌ์ŠคํŠธ +
+
+ํฌ์ŠคํŠธ ํŽ˜์ด์ง€ & ์ƒ์„ธ ํŽ˜์ด์ง€ +
+ +|ํฌ์ŠคํŠธ ํŽ˜์ด์ง€| ํฌ์ŠคํŠธ ์ƒ์„ธํŽ˜์ด์ง€ | +|:---:|:---:| +|| + +
+
+ +
+
+ํฌ์ŠคํŠธ ๋Œ“๊ธ€๋‹ฌ๊ธฐ & ์ˆ˜์ •, ์‚ญ์ œ +
+ +|ํฌ์ŠคํŠธ ๋Œ“๊ธ€๋“ฑ๋ก| +|:---:| +| + +|ํฌ์ŠคํŠธ ๋Œ“๊ธ€์ˆ˜์ •| +|:---:| +| + +|ํฌ์ŠคํŠธ ๋Œ“๊ธ€์‚ญ์ œ| +|:---:| +| +
+