express boilerplate

node.js, express.js boilerplate sequelize orm

node.js, express.js를 사용하여 RESTFUL API를 구축하고 속편을 사용하여 RESTFUL API를 구축하기위한 템플릿 리포지토리 보일러 플레이트. 이 템플릿에는 필요한 경우 저장소에 병합하기위한 공통 기능 별 분기가 포함되어 있습니다.

사전 반품

• Node.js 버전 18.16.1을 설치하십시오
• MySQL 8을 설치하십시오
• MySQL에서 명명 된 데이터베이스를 만듭니다

시작하기

• 템플릿에서 저장소를 만듭니다

• 프로젝트의 루트에서 .env 파일을 작성하고 참조 점검을 위해 값으로 채우십시오.

 cd <project_name>
 cp .env.example .env

• 종속성을 설치하십시오

 npm install

• 마이그레이션을 실행하십시오

 npx sequelize db:migrate

• 파종자로 데이터베이스를 채우십시오

 npx sequelize db:seed:all

• 개발 대상 프로젝트 시작

 npm run dev

• 생산 대상 프로젝트 시작

 npm start

http://localhost:4040 으로 이동하십시오

es lint and pretier

• 서식이 다음을 사용하여 더 예쁘게 규칙과 일치하는지 확인하십시오.

 npm run format

• 이 명령을 사용하여 서식을 강제로 강제하십시오.

 npm run format:fix

• 코드를 다음과 함께 보풀

 npm run lint

• 이 명령을 사용하여 라인을 강제하십시오.

 npm run lint:fix

지점

분기를 병합하여 아래 나열된 기능을 구현하십시오

특징

• Swagger Docs : feat/swagger-docs
• Twilio SMS : feat/twilio-SMS
• Sendgrid Emai : feat/sendgrid-mail
• AWS S3 버킷 : feat/AWS-S3-bucket
• 소켓 : feat/sockets
• 노드 크론 : feat/node-cron

CI (계속 통합)

• JEST 통합 테스트 (GIT 조치) : ci/jest-test

메모

분기없이 저장소를 만들었거나 모든 지점을 얻지 않고 특정 기능 지점을 얻으려면 아래 명령을 실행하여 특정 지점을 가져올 수 있습니다.

 git remote add template <template_repository_url>
git fetch template <template_repo_branch_name>
git checkout <template_repo_branch_name>
git push origin <template_repo_branch_name>

Specfic Branch가 REPO로 밀어 올 위의 명령을 실행함으로써.