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
-### π¦ μ μ μ μΈ κΈ°λ₯
-
\ No newline at end of file
+## π¦ Demo Image
+
+#### π DeskTop
+
+
+
+#### π 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",