Hello, Checkuree!

• 안녕하세요 ! 우리의 출석 체크를 도와줄 개구리, 체쿠리입니다.
• 체쿠리는 소규모 학원이나 학교에서 사용할 수 있는 출석 관리 서비스입니다.
• 여러분이 필요한 요일,시간대의 출석부를 생성해서 출석 관리를 해보세요 !

🌐 Links

Service : https://checkuree.com
Swagger : https://checkuree.com/api/v1/swagger

🖥️ Example Screens

출석부 목록 화면	출석부 생성 화면	출석체크 화면

⚙️ How to Start

0️⃣ Prerequisites

• Node.js 20.12.2
• npm 10.5.0
• yarn 1.22.22

1️⃣ Installation

Back-End

$ cd server
$ npm install

Front-End

$ cd client
$ yarn install

2️⃣ Running the app

Back-End

# before running, you need to fill .env.local file in server directory
# and need to start docker mysql container

# local
$ npm run start:local

# production mode
$ npm run start:prod

# Docker
$ docker-compose build
$ docker-compose up

Front-End

# development
$ yarn dev

# production mode
$ yarn start

Back-End Test

# move to server directory
$ cd server

# service layer tests
$ npm run test

✏️ ERD Diagram

⚒️ Stacks

Infra

Front-End

Back-End

Database

Deploy