Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ jobs:
with:
args: deploy --only hosting
env:
FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
6 changes: 2 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
140 changes: 100 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,109 @@

# 🌈 ConStu (Connect to Study, 스터디를 잇다)
# <img src="./assets/img/logo.png" width="35px" height="35px"> ConStu (Connect to Study, 스터디를 잇다)

<a href="https://github.com/CodeSoom/project-react-2-saseungmin/actions?query=workflow%3ACI">
<img src="https://img.shields.io/github/workflow/status/CodeSoom/project-react-2-saseungmin/CI?label=CI&logo=GitHub&style=flat-square" />

<a href="https://github.com/CodeSoom/ConStu/actions?query=workflow%3ACI">
<img src="https://img.shields.io/github/workflow/status/CodeSoom/ConStu/CI?label=CI&logo=GitHub&style=flat-square" />
</a>

<a href="https://github.com/CodeSoom/project-react-2-saseungmin/actions?query=workflow%3ACD">
<img src="https://img.shields.io/github/workflow/status/CodeSoom/project-react-2-saseungmin/CD?label=build&logo=GitHub&style=flat-square" />
<a href="https://github.com/CodeSoom/ConStu/actions?query=workflow%3ACD">
<img src="https://img.shields.io/github/workflow/status/CodeSoom/ConStu/CD?label=build&logo=GitHub&style=flat-square" />
</a>

<a href="https://codecov.io/gh/CodeSoom/ConStu">
<img src="https://codecov.io/gh/CodeSoom/ConStu/branch/main/graph/badge.svg?token=RNS1FQH8O9"/>
</a>

<a href="https://github.com/CodeSoom/project-react-2-saseungmin/issues">
<img src="https://img.shields.io/github/issues/CodeSoom/project-react-2-saseungmin?style=flat-square" />

<a href="https://github.com/CodeSoom/ConStu/actions?query=workflow%3ACI">
<img src="https://img.shields.io/badge/passing-4c1?style=flat-square&label=CodeceptJS&logo=CodeceptJS" />
</a>

<a href="https://github.com/CodeSoom/ConStu/issues">
<img src="https://img.shields.io/github/issues/CodeSoom/ConStu?style=flat-square" />
</a>

<a href="https://github.com/CodeSoom/ConStu/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/CodeSoom/ConStu?style=flat-square">
</a>

### 🚀 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)

<a href="https://velog.io/@saseungmin/%EC%BD%94%EB%93%9C%EC%88%A8-2%EA%B8%B0-%EA%B7%B8-3%EB%8B%AC%EA%B0%84%EC%9D%98-%EC%97%AC%EC%A0%95">
<img src="https://img.shields.io/badge/Velog: 코드숨 2기 그 3달간의 여정!-20c997?style=flat-square&logo=Vimeo&logoColor=white"/>
<img src="https://img.shields.io/badge/코드숨 2기 그 3달간의 여정!-20c997?style=flat-square&logo=Vimeo&logoColor=white"/>
</a>

</br>

<a href="https://haranglog.tistory.com/23">
<img src="https://img.shields.io/badge/Tistory: 코드숨 2기 그 3달간의 여정!-f76707?style=flat-square&logo=Blogger&logoColor=white"/>
<img src="https://img.shields.io/badge/코드숨 2기 그 3달간의 여정!-f76707?style=flat-square&logo=Blogger&logoColor=white"/>
</a>

- [전체 회고](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

Expand All @@ -73,7 +118,8 @@ https://sweet-1cfff.web.app/

#### 📢 Run tests

- watch test
- Run unit test and e2e test

```bash
> npm test
```
Expand All @@ -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
Expand All @@ -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)

Expand All @@ -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)
## 🦄 Demo Image

#### 👉 DeskTop

![desktop-demo](./assets/img/desktop-demo.gif)

#### 👉 Mobile

<img src="./assets/img/mobile-demo.gif" width="600px" >
Binary file added assets/img/desktop-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/mobile-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/img/전체 개인프로젝트 상태.jpg
Binary file not shown.
2 changes: 1 addition & 1 deletion jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"compilerOptions": {
"allowJs": true
}
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down