An open API service indexing awesome lists of open source software.

https://github.com/codestates-seb/seb43_pre_035


https://github.com/codestates-seb/seb43_pre_035

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

## ๐Ÿฆ‰ Owly







* Team Nameย :ย Hoot
* Project Nameย :ย Owly
* A Website For Programmers To Ask And Answer Questions
* Stack Overflow Clone Coding
* Durationย :ย 2023.04.14 - 2023.04.27
* Link : Click HERE to experience Owly!

## ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Team members
| ์ด์—ฐ์ˆ˜
(BE Leader) | ์ „์ง€์˜
(BE) | ๊ณ ์œ ๊ฐ•
(BE) |
|:--------:| :--------: | :--------: |
| ์ด์—ฐ์ˆ˜| ์ „์ง€์˜ | ๊ณ ์œ ๊ฐ• |
|[@yeonssu](https://github.com/yeonssu) | [@jyoungGrace](https://github.com/jyoungGrace) | [@KYOOKANG](https://github.com/KYOOKANG) |
|


- Signup
- Automated welcome email
- Spring Security
(Authentication, Authorization,
JWT, OAuth)
- Member CRUD
- AWS deployment |

- Question CRUD
- Answer CUD
- Search by title, content
- viewCount increase function
- Adopt answers |

- Question Reply CUD
- Answer Reply CUD
- Exception Code |

| ์žฅ์„ฑ์•„
(FE Leader) | ์ง€์šฐ์„
(FE) | ๊ณ ์ƒ๋ฏผ
(FE) |
| :--------: | :--------: | :--------: |
| ์žฅ์„ฑ์•„ | ์ง€์šฐ์„ | ๊ณ ์ƒ๋ฏผ |
| [@splazt](https://github.com/splazt) | [@Zeereoreo](https://github.com/Zeereoreo) | [@Gorden-Dosi](https://github.com/Gorden-Dosi) |
|

- Main Page (Inf. Scroll)
- UI Design & User Flow Head
- Token Authentication
- Login Status & Member
ย  ย  Access Control
- Ask Page (C)
- Q&A & QA-Replies CRUD
- Header / Sidebar
- Responsive Design
|

- Question Page
- Question UD
- Answer CRUD
- QA-Replies CRUD
- Members-Only Features
- Header
- AWS Deployment / Release
|

- Member Info Page (RUD)
- Login (R), Signup (C) Page
- ID/PW Validation
- Logo Design
||||

## ๐Ÿ“Œ Introduction to Project Features

### ํšŒ์› ๊ธฐ๋Šฅ
- ํšŒ์›๊ฐ€์ž…
- ๋กœ๊ทธ์ธ / ๋กœ๊ทธ์•„์›ƒ
- ํšŒ์› ์ •๋ณด ์กฐํšŒ (๋งˆ์ดํŽ˜์ด์ง€)
- ํšŒ์› ์ •๋ณด ์ˆ˜์ • (์ž์‹ ์˜ ์ •๋ณด๋งŒ ์ˆ˜์ • ๊ฐ€๋Šฅ)
- ํšŒ์› ์ •๋ณด ์‚ญ์ œ (์ž์‹ ์˜ ์ •๋ณด๋งŒ ์‚ญ์ œ ๊ฐ€๋Šฅ)

### ์งˆ๋ฌธ(๊ฒŒ์‹œ๊ธ€) ๊ธฐ๋Šฅ
- ์งˆ๋ฌธ ์กฐํšŒ (ํšŒ์›์ด ์•„๋‹Œ ์‚ฌ๋žŒ๋„ ์กฐํšŒ ๊ฐ€๋Šฅ)
- ๊ด€๋ จ ๋‹ต๋ณ€, ๋Œ“๊ธ€ ๋ชจ๋‘ ์กฐํšŒ ๊ฐ€๋Šฅ
- ์งˆ๋ฌธ ์ž‘์„ฑ (ํšŒ์›๋งŒ ๊ฐ€๋Šฅ)
- ์งˆ๋ฌธ ์ˆ˜์ • (์งˆ๋ฌธ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ์งˆ๋ฌธ ์‚ญ์ œ (์งˆ๋ฌธ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ์งˆ๋ฌธ ์‚ญ์ œ ์‹œ, ์งˆ๋ฌธ ์กฐํšŒ ๋ถˆ๊ฐ€๋Šฅ
- ์งˆ๋ฌธ ์‚ญ์ œ ์‹œ, ๊ด€๋ จ ๋‹ต๋ณ€ ๋ชจ๋‘ ์กฐํšŒ ๋ถˆ๊ฐ€๋Šฅ
- ์งˆ๋ฌธ ์‚ญ์ œ ์‹œ, ๊ด€๋ จ ๋Œ“๊ธ€ ๋ชจ๋‘ ์กฐํšŒ ๋ถˆ๊ฐ€๋Šฅ

### ๋‹ต๋ณ€ ๊ธฐ๋Šฅ
- ๋‹ต๋ณ€ ์ž‘์„ฑ (๋‹ต๋ณ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€ ์ˆ˜์ • (๋‹ต๋ณ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€ ์‚ญ์ œ (๋‹ต๋ณ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€ ์ฑ„ํƒ ๊ธฐ๋Šฅ (์งˆ๋ฌธ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)

### ๋Œ“๊ธ€ ๊ธฐ๋Šฅ
- ์งˆ๋ฌธ์— ๋Œ“๊ธ€ ์ž‘์„ฑ (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ์งˆ๋ฌธ์— ๋‹ฌ๋ฆฐ ๋Œ“๊ธ€ ์ˆ˜์ • (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ์งˆ๋ฌธ์— ๋‹ฌ๋ฆฐ ๋Œ“๊ธ€ ์‚ญ์ œ (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€์— ๋Œ“๊ธ€ ์ž‘์„ฑ (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€์— ๋‹ฌ๋ฆฐ ๋Œ“๊ธ€ ์ˆ˜์ • (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)
- ๋‹ต๋ณ€์— ๋‹ฌ๋ฆฐ ๋Œ“๊ธ€ ์‚ญ์ œ (๋Œ“๊ธ€ ์ž‘์„ฑ์ž๋งŒ ๊ฐ€๋Šฅ)

## ๐Ÿ’ป Stacks Used
### Back-end
| Java | Spring | Spring Boot | Spring Security | MySQL | AWS |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
|

icon
| spring logo | spring-boot logo | spring-security logo |
icon
|
icon
|

### Front-end
| Html | CSS | JavaScript | React | Styled
Components | axios | esLint | Figma | React
Router |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
| Html |

CSS
|
icon
|
icon
|
styled-components icon
|
|
|
|
|

### Tools
| Github | Discord | Notion |
| :--------: | :--------: | :------: |
| github logo | Discord logo | Notion logo |

## ๐Ÿ”– Project Docs

### ์‚ฌ์šฉ์ž ์š”๊ตฌ์‚ฌํ•ญ ์ •์˜์„œ
requirement
requirement

### DB Diagram
schema

### Prototyping
[Wireframe Link (Figma)](https://www.figma.com/file/MaOjCuQ53oy3nMzOpHCvfi/ํ™”๋ฉด-์ •์˜์„œ?node-id=38%3A176&t=hsQJoweA07WvGrFY-1)

#### User Flow
userflow

#### UI Style (Figma)

UI style
UI style

#### Prototype (Figma)

Prototype

## ๐Ÿ”— Github Rule

### Commit Convention

| Message | ์„ค๋ช… |
| :--------: | :---------------------------------------------------- |
| `add` | ์ƒˆ๋กœ์šด ํ”„๋กœ์ ํŠธ, ํŒŒ์ผ ๋“ฑ ์ถ”๊ฐ€ |
| `feat` | ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ |
| `fix` | ๋ฒ„๊ทธ ์ˆ˜์ • |
| `refactor` | ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง |
| `style` | ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ ๋“ฑ |
| `remove` | ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํŒŒ์ผ ๋˜๋Š” ํด๋” ์‚ญ์ œ |
| `rename` | ํŒŒ์ผ ๋˜๋Š” ํด๋”๋ช… ์ˆ˜์ • |
| `chore` | ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ • |

### Branch

- `main` : ์„œ๋น„์Šค ์šด์˜ ๋ธŒ๋žœ์น˜
- `dev` : ๋ฉ”์ธ ๋ธŒ๋žœ์น˜ ๋ฐฐํฌ์ „ ๋ฆด๋ฆฌ์ฆˆ ๋ธŒ๋žœ์น˜
- `be-dev` : BE ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๋ธŒ๋žœ์น˜
- `fe-dev` : FE ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๋ธŒ๋žœ์น˜
- `be-feat/[feature name]` : BE ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜
- `fe-feat/[feature name]` : FE ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ๋ธŒ๋žœ์น˜

## Upcoming Features

- ์งˆ๋ฌธ ๋ชฉ๋ก ํ•„ํ„ฐ๋ง ๋ฐ ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ
- ๋‹ต๋ณ€ ์ฑ„ํƒ ๊ธฐ๋Šฅ
- ์›น์—๋””ํ„ฐ
- Google OAuth
- ๋ชจ๋ฐ”์ผ ๋ฐ˜์‘ํ˜• ๋””์ž์ธ (๋‚ด๋น„๊ฒŒ์ด์…˜, ์‚ฌ์ด๋“œ๋ฐ”)