Eco3S Backend API & Spec (⚠️Deprecated⚠️)

Warning
본 저장소는 개발이 중단되었습니다. 새 백엔드 구현체를 사용해 주세요.

개요

eco3s 서비스에서 사용할, API명세와 백엔드 로직을 관리하는 레포지토리입니다.

Stack

Name	Position	Note	Link
Docker	container manager	DB와 웹 서버 컨테이너 실행 및 관리	homepage github org
ESbuild	bundler	배포시 코드 bundling, minifying, tree shacking (DCE)	homepage github
ESlint	lint	코드 품질 검사 및 강제화 도구	homepage github
Express	backend framework	API 구현 담당	homepage github
FNM	node manager	개발에 필요한 Node 환경을 파일을 통해 재현	github
Git	version manager	git flow와 유사한 워크플로 적용	homepage repository
Husky	git hook manager	pre-commit 훅 관리	homepage github
Jest	unit test runner	유닛 테스트 검증(assert) 및 실행(runner)	homepage github
JWT	http authentication	Stateless 한 인증 시스템 구현	homepage github
Make (GNU)	build system	여러 빌드 명령어를 그룹화하고 종속성을 묘사하기 위해 사용	homepage
Mongodb	database	메인 데이터베이스	homepage github
Nginx	web server / proxy	API서버 프록시 및 프런트엔드 서빙	homepage repository
Node	runtime	개발 / 배포시 코드 및 기타 툴 실행	homepage github
OpenAPI	API specification	획일화된 API문서화 담당. yaml파일로 문서 작성.	homepage github
Prettier	code formatter	git diff관리를 위한 일관적인 코드 포맷터	homepage github
Prisma	ORM / ODM	스키마 정의 및 관리, MongoDB와의 통신에 사용	homepage github
Redocly	OAS doc bundler	yaml로 된 OpenAPI 문서를 검증하고 단일 파일로 번들링	homepage github
Supertest	integrated test	제작된 API를 실제와 유사한 환경으로 통합 테스트	homepage
Swagger UI	API document UI	프런트엔드 개발자들을 위한 API 엔드포인트 시각화	homepage github
SWC	compiler	Rust로 작성된 빠르고 확장 가능한 컴파일러이자 번들러	homepage github
Typescript	language	컴파일 타임에 스키마와 타입을 검증 가능한 상위 레이어	homepage github
Winston	logger	각종 예기치 못한 에러에 대응하기 위한 로거 프레임워크	github

빌드 & 실행

Warning
아래의 모든 방법은 x86_64(amd64)아키텍처의 Arch Linux 5.19.4 커널 위에서만 테스트되었습니다.
다른 환경을 사용할 경우 실행시 예기치 못한 결과가 발생할 수 있습니다.
만약 특정 환경에서만 발생하는 에러를 발견하셨다면, 언제든지 구체적인 에러 메시지와 함께 저를 호출해 주세요.

도커 설치

컴포즈를 사용하기 위해서는 먼저 도커를 설치해야 합니다.

만약 자신의 OS가 리눅스라면 docker를, 그렇지 않다면 docker desktop을 설치하길 권장합니다.

설치 확인

$ docker -v

아래와 비슷한 결과가 나오면 설치를 확신할 수 있습니다.

Docker version 20.10.17, build 100c70180f

도커 컴포즈 설치

Compose V2를 사용합니다.

Note
도커 데스크톱을 설치하셨다면 이미 docker compose를 사용하실 수 있습니다.

Arch Linux

별다른 공식 지원이 없기에 수동으로 compose 플러그인을 설치합니다.

아래의 예제에서는 2.10.2 버전을 사용합니다.

$ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
$ mkdir -p $DOCKER_CONFIG/cli-plugins
$ curl -SL https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose

설치 확인

도커 데스크톱을 설치하셨더라도 확인을 위해 해 주세요

$ docker compose version

아래와 비슷한 결과가 나오면 설치를 확신할 수 있습니다.

Docker Compose version v2.10.2

수동으로 설치한 경우, 입력한 플러그인 버전이 일치하는지 확인해 주세요.
(이 경우 2.10.2)

실행

다음 명령으로 모든 컨테이너를 활성화시킬 수 있습니다.

$ docker compose up -d

Note
몇 분에서 최대 10분 정도까지 시간이 소요될 수 있습니다. 한번 빌드 캐시가 만들어지고 로컬에 이미지가 저장되고 나면 앞으로 실행할 때는 빨리 실행되니 걱정하지 마세요.

DB

DB로는 mongodb를 사용합니다.

연결

기본적으로 27017포트를 사용합니다.

데이터베이스명은 eco3s를 사용합니다.

mongosh 'mongodb://localhost:27017/eco3s'

일반적으로 DB에 직접 연결하실 필요는 없습니다.

데이터 관리

한번 초기화된 이상, 모든 데이터는 data 볼륨에 영구히 저장됩니다.

데이터를 삭제하고 깨끗한 새 DB를 만들기 위해서는 다음 명령어를 입력해 주세요.

$ docker compose down -v

Warning
이 명령어는 hot reload를 하지 않습니다.
이 명령어는 현재 실행중인 모든 컨테이너를 종료시킵니다.
지워진 DB에 다시 연결하고 싶다면 다시 한번 docker compose up -d가 필요합니다.

Warning
이 명령어는 현재까지 저장된 볼륨을 모두 삭제합니다.
중요한 데이터가 있다면 백업을 먼저 진행해 주세요.

App

백엔드 서버는 8888 포트에서 작동합니다.

curl localhost:8888/ # 안내 페이지

curl localhost:8888/api/users # 모든 유저 목록을 가져오는 API 실행

/(루트 경로, 해당 경우 localhost:8888/)로 들어가면 임시 안내 페이지가 등장합니다.

안내 페이지의 설명을 따라 API문서 혹은 Prisma 문서를 사용하실 수 있습니다.

종료

해당 앱을 종료하고 싶으시다면 다음 명령어를 사용해 주세요.

$ docker compose stop

종료와 함께 모든 컨테이너를 지우고 싶으시다면 다음 명령어를 사용해 주세요.

$ docker compose down

종료와 함께 모든 컨테이너와 모든 볼륨을 지우고 싶으시다면 다음 명령어를 사용해 주세요.

$ docker compose down -v

유닛 테스트

다음 명령어로 유닛 테스트를 실행할 수 있습니다.

docker compose run --tty=false --interactive=false app npx jest --verbose --silent=false

만약 소스를 수정했다면, 커밋 전에 반드시 유닛 테스트를 돌려 주세요.

오류 해결

만약 해당 저장소에서 오류를 발견했거나 위 코드를 실행하던 중 정상적인 빌드가 되지 않으면 언제든지 관련 에러 메시지와 함께 저를 호출해 주세요.

작성자

• Abiria

라이선스