diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index 360a9db..5203f4d 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -49,4 +49,4 @@ jobs: with: args: deploy --only hosting env: - FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }} \ No newline at end of file + FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a436959..3ab1bc2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,14 +5,12 @@ on: branches: [ main ] jobs: - build: - + test: + name: CI runs-on: ubuntu-latest - strategy: matrix: node-version: [12.x] - steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} diff --git a/README.md b/README.md index 8e7ac28..3b406f0 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,109 @@ -# 🌈 ConStu (Connect to Study, μŠ€ν„°λ””λ₯Ό μž‡λ‹€) +# ConStu (Connect to Study, μŠ€ν„°λ””λ₯Ό μž‡λ‹€) - - + + + - - + + - - - + + + + + + + + + + + -### πŸš€ Hosting URL -https://sweet-1cfff.web.app/ +## πŸš€ Hosting URL -### 🎈 μ‚¬μš© λͺ©μ  및 μ†Œκ°œ -- λ„€? λ­λΌκ³ μš”??πŸ™‹β€β™‚οΈ μŠ€ν„°λ””λ₯Ό μ°Ύκ³  μžˆλ‹€κ΅¬μš”?πŸ€” μŠ€ν„°λ””μ— κ΄€ν•œ μ •λ³΄λŠ” λͺ¨λ‘ 여기에!! 🌈 Get started right now! πŸš€ +https://sweet-1cfff.firebaseapp.com + +## 🎈 μ‚¬μš© λͺ©μ  및 μ†Œκ°œ +- λ„€? λ­λΌκ³ μš”??πŸ™‹β€β™‚οΈ μŠ€ν„°λ””λ₯Ό μ°Ύκ³  μžˆλ‹€κ΅¬μš”?πŸ€” μŠ€ν„°λ””μ— κ΄€ν•œ μ •λ³΄λŠ” λͺ¨λ‘ 여기에!! - 개발과 κ΄€λ ¨ν•œ λ˜λŠ” IT와 κ΄€λ ¨λœ μŠ€ν„°λ””λ₯Ό μ°Ύκ³  같이 κ³΅λΆ€ν•˜κ³  μ†Œν†΅ν•˜κ³  싢을 λ•Œ μ‚¬μš©ν•©λ‹ˆλ‹€. +- 이 ν”„λ‘œμ νŠΈλŠ” ν”„λ‘ νŠΈμ•€λ“œ κ°œλ°œμ— μ§‘μ€‘ν•˜κΈ° μœ„ν•΄ λ°±μ•€λ“œ κ΅¬ν˜„μ„ μ΅œμ†Œν™”ν•˜μ˜€κ³ , 그에 따라 firebaseλ₯Ό μ‚¬μš©ν•˜μ˜€μŠ΅λ‹ˆλ‹€. +- 2021.06.10(λͺ©) κΈ°μ€€μœΌλ‘œ 316개의 λ‹¨μœ„ ν…ŒμŠ€νŠΈμ™€ Code CoverageλŠ” 99.6% 이고 41개의 e2e ν…ŒμŠ€νŠΈ μ‹œλ‚˜λ¦¬μ˜€κ°€ μ‘΄μž¬ν•©λ‹ˆλ‹€. + +## πŸ’» Project Structure + +``` +πŸ“¦src + ┣ πŸ“‚ assets + ┃ ┣ πŸ“‚ css + ┃ β”— πŸ“‚ icons + ┣ πŸ“‚ components + ┃ ┣ πŸ“‚ auth + ┃ ┣ πŸ“‚ base + ┃ ┣ πŸ“‚ common + ┃ ┣ πŸ“‚ introduce + ┃ ┃ ┣ πŸ“‚ modals + ┃ ┣ πŸ“‚ loader + ┃ ┣ πŸ“‚ main + ┃ β”— πŸ“‚ write + ┣ πŸ“‚ containers + ┃ ┣ πŸ“‚ auth + ┃ ┣ πŸ“‚ base + ┃ ┣ πŸ“‚ groups + ┃ ┣ πŸ“‚ introduce + ┃ β”— πŸ“‚ write + ┣ πŸ“‚ pages + ┣ πŸ“‚ reducers + ┣ πŸ“‚ services + ┣ πŸ“‚ styles + ┣ πŸ“‚ util + ┃ ┣ πŸ“‚ config + ┃ ┣ πŸ“‚ constants + ┣ πŸ“œ App.jsx + ┣ πŸ“œ App.test.jsx + β”— πŸ“œ index.jsx +``` -### 🎯 개발 κΈ°κ°„ +## πŸ‘‰ 개발 κΈ°κ°„ - 2020.11.16 ~ 2020.12.13 (1달) -- κ³„μ†ν•΄μ„œ κΈ°λŠ₯ μΆ”κ°€ν•΄ λ³Ό μ˜ˆμ • [:link:](https://github.com/CodeSoom/project-react-2-saseungmin/issues/115) -### πŸš€ ν”„λ‘œμ νŠΈ μ£Ό 차별 κ³„νš 및 회고 -#### 🎯 1 μ£Όμ°¨ -- [1μ£Όμ°¨ κ³„νš](https://github.com/CodeSoom/project-react-2-saseungmin/issues/1) -- [1μ£Όμ°¨ 회고](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_9) +- **κ³„μ†ν•΄μ„œ κΈ°λŠ₯ μΆ”κ°€ 쀑..** [:link:](https://github.com/CodeSoom/ConStu/issues/115) -#### 🎯 2 μ£Όμ°¨ -- [2μ£Όμ°¨ κ³„νš](https://github.com/CodeSoom/project-react-2-saseungmin/issues/20) -- [2μ£Όμ°¨ 회고](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_10) +## πŸš€ ν”„λ‘œμ νŠΈ μ£Ό 차별 κ³„νš 및 회고 -#### 🎯 3 μ£Όμ°¨ -- [3μ£Όμ°¨ κ³„νš](https://github.com/CodeSoom/project-react-2-saseungmin/issues/44) -- [3μ£Όμ°¨ 회고](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_11) +|πŸ‘‰ μ£Όμ°¨|κ³„νš|회고| +|:---:|:---:|:---:| +|1 μ£Όμ°¨|[:link:](https://github.com/CodeSoom/ConStu/issues/1)|[:link:](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_9)| +|2 μ£Όμ°¨|[:link:](https://github.com/CodeSoom/ConStu/issues/20)|[:link:](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_10)| +|3 μ£Όμ°¨|[:link:](https://github.com/CodeSoom/ConStu/issues/44)|[:link:](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_11)| +|4 μ£Όμ°¨|[:link:](https://github.com/CodeSoom/ConStu/issues/77)|[:link:](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_12)| -#### 🎯 4 μ£Όμ°¨ (λ§ˆμ§€λ§‰ μ£Όμ°¨) -- [4μ£Όμ°¨ κ³„νš](https://github.com/CodeSoom/project-react-2-saseungmin/issues/77) -- [4μ£Όμ°¨ 회고](https://github.com/saseungmin/codesoom_code_review_repository/tree/master/week_12) +## 🎯 μ½”λ“œμˆ¨ ν›„κΈ° 및 전체 회고 -#### 🎯 μ½”λ“œμˆ¨ ν›„κΈ° 및 전체 회고 +- [전체 회고](https://github.com/saseungmin/codesoom_code_review_retrospective) - +
- + -- [전체 회고](https://github.com/saseungmin/codesoom_code_review_retrospective) -### πŸ“š Project Settings +## ✌️ μ§„ν–‰ 사항 및 μ°Έκ³  사항 +- [μ§„ν–‰ 사항](https://github.com/CodeSoom/ConStu/issues/115) +- [react-draft-wysiwyg editor 에 λŒ€ν•œ 버그 사항](https://github.com/CodeSoom/ConStu/issues/108) +- [Firebase api킀에 λŒ€ν•œ μ°Έκ³  사항](https://github.com/CodeSoom/ConStu/issues/133) + +## πŸ“š Project Settings #### πŸ“’ Install npm dependencies @@ -73,7 +118,8 @@ https://sweet-1cfff.web.app/ #### πŸ“’ Run tests -- watch test +- Run unit test and e2e test + ```bash > npm test ``` @@ -83,6 +129,12 @@ https://sweet-1cfff.web.app/ > npm run test:unit ``` +- Run e2e test + +```bash +> npm run test:e2e +``` + #### πŸ“’ Run build project ```bash @@ -101,12 +153,13 @@ https://sweet-1cfff.web.app/ > npm run coverage ``` -### πŸ“š Getting start with firebase +- μžμ„Έν•œ 사항은 `package.json`의 `scripts` μ°Έκ³  + +## πŸ“š Getting start with firebase - [Firebase](https://firebase.google.com/) - [Docs](https://firebase.google.com/docs/cli?hl=ko) #### πŸ“’ firebase APIν‚€ 관리 -- Firebase API ν‚€ 관리 μ „λž΅ λ³€κ²½(2021. 01. 08) - [Firebase API ν‚€ 관리에 λŒ€ν•œ μ°Έκ³  사항](https://github.com/CodeSoom/project-react-2-saseungmin/issues/133) - [Firebase API 킀에 λŒ€ν•΄μ„œ μž‘μ„±ν•œ λΈ”λ‘œκ·Έ κΈ€](https://haranglog.tistory.com/25) @@ -129,20 +182,27 @@ https://sweet-1cfff.web.app/ > firebase deploy ``` -### πŸ”₯ 기술 μŠ€νƒ 및 μ‚¬μš© 라이브러리 +## πŸ”₯ 기술 μŠ€νƒ 및 μ‚¬μš© 라이브러리 - React - Redux, Redux-Toolkit, Redux-Thunk - React Router Dom - React Helmet - React Use -- Emotion +- Emotion, facepaint, react-responsive - Firebase, FireStore -- Jest, React Testing Library +- Jest, React Testing Library, CodeceptJS - Webpack, Eslint, Babel - Immer - Moment, React-moment - draft-js, react-draft-wysiwyg - react-content-loader -### πŸ¦„ μ „μ œμ μΈ κΈ°λŠ₯ -![전체 κ°œμΈν”„λ‘œμ νŠΈ μƒνƒœ](./assets/img/전체%20κ°œμΈν”„λ‘œμ νŠΈ%20μƒνƒœ.jpg) \ No newline at end of file +## πŸ¦„ Demo Image + +#### πŸ‘‰ DeskTop + +![desktop-demo](./assets/img/desktop-demo.gif) + +#### πŸ‘‰ Mobile + + diff --git a/assets/img/desktop-demo.gif b/assets/img/desktop-demo.gif new file mode 100644 index 0000000..5c6b911 Binary files /dev/null and b/assets/img/desktop-demo.gif differ diff --git a/assets/img/logo.png b/assets/img/logo.png new file mode 100644 index 0000000..c163ada Binary files /dev/null and b/assets/img/logo.png differ diff --git a/assets/img/mobile-demo.gif b/assets/img/mobile-demo.gif new file mode 100644 index 0000000..3f6eac7 Binary files /dev/null and b/assets/img/mobile-demo.gif differ diff --git "a/assets/img/\354\240\204\354\262\264 \352\260\234\354\235\270\355\224\204\353\241\234\354\240\235\355\212\270 \354\203\201\355\203\234.jpg" "b/assets/img/\354\240\204\354\262\264 \352\260\234\354\235\270\355\224\204\353\241\234\354\240\235\355\212\270 \354\203\201\355\203\234.jpg" deleted file mode 100644 index a86b42f..0000000 Binary files "a/assets/img/\354\240\204\354\262\264 \352\260\234\354\235\270\355\224\204\353\241\234\354\240\235\355\212\270 \354\203\201\355\203\234.jpg" and /dev/null differ diff --git a/jsconfig.json b/jsconfig.json index 567aa6e..b18e5bc 100644 --- a/jsconfig.json +++ b/jsconfig.json @@ -2,4 +2,4 @@ "compilerOptions": { "allowJs": true } -} \ No newline at end of file +} diff --git a/package.json b/package.json index 4d3237b..81c8fb6 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "coverage": "npm run test:unit -- --coverage", "coverage:ci": "npm run test:unit --ci --coverage && codecov", "lint": "eslint --ext js,jsx .", - "build": "cross-env NODE_ENV=production webpack --progress" + "build": "cross-env NODE_ENV=production webpack" }, "repository": { "type": "git",