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. ํฌ์คํธ + + +ํฌ์คํธ ํ์ด์ง & ์์ธ ํ์ด์ง + + +|ํฌ์คํธ ํ์ด์ง| ํฌ์คํธ ์์ธํ์ด์ง | +|:---:|:---:| +|| + + + + + + +ํฌ์คํธ ๋๊ธ๋ฌ๊ธฐ & ์์ , ์ญ์ + + +|ํฌ์คํธ ๋๊ธ๋ฑ๋ก| +|:---:| +| + +|ํฌ์คํธ ๋๊ธ์์ | +|:---:| +| + +|ํฌ์คํธ ๋๊ธ์ญ์ | +|:---:| +| + +