whatsapp-api

(★ 1,279)

CodeChat - WhatsApp Api

  • .env.dev
  • .gitignore
  • .prettierrc.js
  • CHANGELOG.md
  • deploy_db.sh
  • docker-compose.yml
  • Dockerfile
  • ecosystem.config.mjs
  • eslint.config.mjs
  • LICENSE
  • package.json
  • prisma.config.mjs
  • PROJECT_STRUCTURE.md
  • README.md
  • start.sh
  • thunder-collection_codechat_v1.3.0.json
  • tsconfig.json

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/code-chat-br/whatsapp-api

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd whatsapp-api

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다.
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm i -g pm2

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
curl -fsSL https://get.docker.com -o get-docker.sh

이 명령어를 터미널에 그대로 입력해 실행하세요.

sudo sh get-docker.sh

이 명령어를 터미널에 그대로 입력해 실행하세요.

sudo usermod -aG docker ${USER}

이 명령어를 터미널에 그대로 입력해 실행하세요.

docker-compose up

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Node.js

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
npm i -g pm2

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm install --force

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run start:dev

개발/실행 서버를 켭니다.

npm run start:prod

개발/실행 서버를 켭니다.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation