Skip to content

codestates-seb/seb43_main_016

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

29 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

EduSync

์Šคํ„ฐ๋”” ๋ชจ์ง‘ & ๊ด€๋ฆฌ ํ”Œ๋žซํผ
ํ”„๋ก ํŠธ์—”๋“œ ๋ฐฐํฌ ์ฃผ์†Œ : https://www.edusync.site/
๋ฐฑ์—”๋“œ ๋ฐฐํฌ ์ฃผ์†Œ : https://wish17.store/

ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ ๋ฐ ์†Œ๊ฐœ

ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ : 2023.04.28 ~ 2023.05.25

ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ Edusync๋Š” ์ž์‹ ์ด ์›ํ•˜๋Š” IT ๋ถ„์•ผ์˜ ์Šคํ„ฐ๋”” ๊ทธ๋ฃน์„ ์ฐพ๊ณ , ์Šคํ„ฐ๋”” ๊ทธ๋ฃน์›์˜ ๋ชจ์ง‘ / ๊ตฌ์„ฑ / ๊ด€๋ฆฌ๋ฅผ ๋•๋Š” ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค.

ํŒ€์› ์†Œ๊ฐœ

  • ์ด๋ฏธ์ง€ ๋ˆ„๋ฅด๋ฉด GitHub ์ฃผ์†Œ๋กœ ์—ฐ๊ฒฐ๋ฉ๋‹ˆ๋‹ค.
  • ์ด๋ฆ„์„ ๋ˆ„๋ฅด๋ฉด ๋ธ”๋กœ๊ทธ ์ฃผ์†Œ๋กœ ์—ฐ๊ฒฐ๋ฉ๋‹ˆ๋‹ค.
BE(ํŒ€์žฅ) BE BE FE(ํŒ€์žฅ) FE FE
์ •๋™์šฐ ์œ„์›์ข… ์–‘๋„์—ด ์†กํ•˜์€ ๊ฐ•ํ•˜์„ฑ ์ด์Šนํ˜„
์ •๋™์šฐ ์œ„์›์ข… ์–‘๋„์—ด ์†กํ•˜์€ ๊ฐ•ํ•˜์„ฑ ์ด์Šนํ˜„

Project Diagram & Stack

โœจProject Diagramโœจ diagram โœจBackendโœจ

โœจFrontendโœจ


ํ™”๋ฉด๊ตฌ์„ฑ

์Šคํ„ฐ๋”” ๊ทธ๋ฃน ํƒ์ƒ‰ ์Šคํ„ฐ๋”” ๊ทธ๋ฃน ์ƒ์„ฑ
main-pre-1 main-pre-2
์Šคํ„ฐ๋”” ๊ทธ๋ฃน ๊ด€๋ฆฌ ์Šคํ„ฐ๋”” ์Šค์ผ€์ค„ & ๊ฐœ์ธ ์Šค์ผ€์ค„
main-pre-6 main-pre-4

์ฃผ์š” ๊ธฐ๋Šฅ

๐Ÿ‘ฉโ€๐Ÿ’ป ํšŒ์›๊ฐ€์ž… & ๋กœ๊ทธ์ธ

  • Form ํšŒ์›๊ฐ€์ž… ๋ฐ ๋กœ๊ทธ์ธ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.
  • ์†Œ์…œ ํšŒ์›๊ฐ€์ž… ๋ฐ ๋กœ๊ทธ์ธ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ‘ฉ ๋งˆ์ดํŽ˜์ด์ง€

  • ํšŒ์›ํƒˆํ‡ด๋ฅผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์†Œ์…œ ํšŒ์›์˜ ๊ฒฝ์šฐ ๋กœ๊ทธ์ธ ์ •๋ณด ์ˆ˜์ •์ด ๋ถˆ๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.
  • ์ž๊ธฐ์†Œ๊ฐœ ํ•ญ๋ชฉ์„ ํ†ตํ•ด ์ž์‹ ์— ๋Œ€ํ•ด ์†Œ๊ฐœํ•˜๋Š” ๊ธ€์„ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์ž์‹ ์ด ์›ํ•˜๋Š” ์Šคํ„ฐ๋””์›์˜ ํŠน์ง•์„ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ“– ์Šคํ„ฐ๋”” ์กฐํšŒ, ๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ

  • ์ž์‹ ๋งŒ์˜ ์Šคํ„ฐ๋””๋ฅผ ์กฐํšŒ / ๋“ฑ๋ก / ์ˆ˜์ • / ์‚ญ์ œ๋ฅผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ํƒ€ ํšŒ์›์ด ๋“ฑ๋กํ•œ ์Šคํ„ฐ๋””๋ฅผ ์กฐํšŒ / ๊ฐ€์ž… ์‹ ์ฒญ / ํƒˆํ‡ด๋ฅผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ํƒ€ ํšŒ์›์ด ๋“ฑ๋กํ•œ ๋ชจ์ง‘ ๊ธ€์— ๋Œ“๊ธ€๋กœ ์˜๊ฒฌ์„ ๋‚จ๊ธธ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์Šคํ„ฐ๋”” ๋ชฉ๋ก์„ ์ž์‹ ์ด ์›ํ•˜๋Š” ํ•„ํ„ฐ์— ๋”ฐ๋ผ ์žฌ์ •๋ ฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ‘‘ ๊ถŒํ•œ์— ๋”ฐ๋ฅธ ์˜ˆ์™ธ์ฒ˜๋ฆฌ

  • ์Šคํ„ฐ๋””์žฅ์€ ์Šคํ„ฐ๋”” ๋Œ€๊ธฐ ์ธ์› ์Šน์ธ, ์Šคํ„ฐ๋””์› ๊ฐ•์ œ ํƒˆํ‡ด ๋“ฑ์˜ ๊ถŒํ•œ์„ ๊ฐ–๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์Šคํ„ฐ๋””์žฅ์€ ์Šคํ„ฐ๋”” ๊ทธ๋ฃน์›์—๊ฒŒ ์ž์‹ ์˜ ๊ถŒํ•œ์€ ์œ„์ž„ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์Šคํ„ฐ๋””์žฅ์€ ์Šคํ„ฐ๋””๋ฅผ ํ•ด์ฒดํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ์Šคํ„ฐ๋””์žฅ์€ ์Šค์Šค๋กœ ์Šคํ„ฐ๋”” ํƒˆํ‡ด๊ฐ€ ๋ถˆ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ—“๏ธ ์บ˜๋ฆฐ๋”

  • ์ž์‹ ์ด ์†ํ•œ ์Šคํ„ฐ๋””์˜ ์ผ์ •์„ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ์ž์‹ ๋งŒ์˜ ์Šคํ„ฐ๋”” ์ผ์ •์„ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋””๋ ‰ํ† ๋ฆฌ ๊ตฌ์กฐ

โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ client : ํ”„๋ก ํŠธ์—”๋“œ ๋””๋ ‰ํ† ๋ฆฌ
โ”‚ย ย  โ”œโ”€โ”€ public
โ”‚ย ย  โ”œโ”€โ”€ src
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ apis : ์„œ๋ฒ„ ํ†ต์‹ ์„ ๋‹ด๋‹นํ•˜๋Š” ํ•จ์ˆ˜๋“ค์„ ๋ณ„๋„๋กœ ๊ด€๋ฆฌ
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ assets
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ compoenets : ๊ธฐ๋Šฅ ๋‹จ์œ„ ์ปดํฌ๋„ŒํŠธ
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ hooks : recoil์„ ํ™œ์šฉํ•œ ์ „์—ญ ์ƒํƒœ ๊ด€๋ฆฌ
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ mocks : msw ์ œ์–ด
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ pages : ์ตœ์ข… ๋ Œ๋”๋ง ํŽ˜์ด์ง€ ๊ด€๋ฆฌ
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ recoil : ์ „์—ญ ์ƒํƒœ ๊ด€๋ฆฌ
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ App.css
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ App.tsx
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ GlobalStyle.css
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ ckeditor.d.ts
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ index.css
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ main.tsx
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ vite-env.d.ts
โ”‚ย ย  โ”œโ”€โ”€ index.html
โ”‚ย ย  โ”œโ”€โ”€ package-lock.json
โ”‚ย ย  โ”œโ”€โ”€ package.json
โ”‚ย ย  โ”œโ”€โ”€ tsconfig.json
โ”‚ย ย  โ”œโ”€โ”€ tsconfig.node.json
โ”‚ย ย  โ””โ”€โ”€ vite.config.ts
โ””โ”€โ”€ server : ๋ฐฑ์—”๋“œ ๋””๋ ‰ํ† ๋ฆฌ
    โ”œโ”€โ”€ edusync
     ย ย  โ”œโ”€โ”€ gradle/wrapper
     ย ย  โ””โ”€โ”€ src
     ย ย   ย ย  โ”œโ”€โ”€ docs.asciidoc
     ย ย   ย ย  โ”œโ”€โ”€ main
     ย ย   ย ย  โ”‚   โ”œโ”€โ”€ java/com/codestates/edusync
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ config
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ exception
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ filter
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ handler
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ model
     ย ย   ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ security/auth
     ย ย   ย ย  โ”‚   โ”‚   โ””โ”€โ”€ EdusyncApplication.java
     ย ย   ย ย  โ”‚   โ””โ”€โ”€ resources
     ย ย   ย ย  โ”‚       โ”œโ”€โ”€ db/migration
     ย ย   ย ย  โ”‚       โ”œโ”€โ”€ application-server.yml
     ย ย   ย ย  โ”‚       โ””โ”€โ”€ application.yml
     ย ย   ย ย  โ”œโ”€โ”€ test/java/com/codestates/edusync
     ย ย   ย ย  โ”‚       โ”œโ”€โ”€ config
     ย ย   ย ย  โ”‚       โ”œโ”€โ”€ member
     ย ย   ย ย  โ”‚       โ”œโ”€โ”€ model/study/studygroup
     ย ย   ย ย  โ”‚       โ””โ”€โ”€ EdusyncApplicationTests.java
     ย ย   ย ย  โ”œโ”€โ”€ .gitignore
     ย ย   ย ย  โ”œโ”€โ”€ background_run_app.sh
     ย ย   ย ย  โ”œโ”€โ”€ build.gradle
     ย ย   ย ย  โ”œโ”€โ”€ gradlew
     ย ย   ย ย  โ”œโ”€โ”€ gradlew.bat
     ย ย   ย ย  โ”œโ”€โ”€ run_app.sh
     ย ย   ย ย  โ”œโ”€โ”€ settings.gradle
     ย ย   ย ย  โ””โ”€โ”€ stop8080.sh

์‹œ์ž‘ ๊ฐ€์ด๋“œ

required

Backend

$ cd server
// ์‹œ์ž‘
$ ./run_app_log.sh
// ์ข…๋ฃŒ
$ ./stop8080.sh

Frontend

$ cd client
$ npm install
$ npm run dev
$ npm run preview

Git Convention

Commit Message

Message ์„ค๋ช…
[feat] ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•  ๊ฒฝ์šฐ
[fix] ๋ฒ„๊ทธ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
[design] CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
[style] ์ฝ”๋“œ ํฌ๋งท๋ณ€๊ฒฝ, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ.
[refactor] ํ”„๋กœ๋•์…˜ ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋งํ•  ๊ฒฝ์šฐ
[comment] ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
[docs] ๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•œ ๊ฒฝ์šฐ
[test] ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์—…์„ํ•  ๊ฒฝ์šฐ
[chore] ๋นŒ๋“œ ํ…Œ์ŠคํŠธ ์—…๋ฐ์ดํŠธ, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €๋ฅผ ์„ค์ •ํ•˜๋Š” ๊ฒฝ์šฐ
[rename] ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ ํ•˜๋Š” ๊ฒฝ์šฐ
[remove] ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
[init] ๋ธŒ๋žœ์น˜ ์ดˆ๊ธฐํ™” ๋ฐ ์ดˆ๊ธฐ์…‹ํŒ… ๊ด€๋ จ๋œ ์„ค์ •์ผ ๊ฒฝ์šฐ

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published