generators

(★ 234)

API Generator - instantly generate REST and GraphQL APIs (openapi (OAS) 3.0.0)

  • .eslintrc
  • .gitignore
  • graphql-mutation.png
  • graphql-schema.png
  • graphql.png
  • index.js
  • License
  • logo.png
  • monkey.png
  • package-lock.json
  • package.json
  • README.api.md
  • README.app.md
  • README.dev
  • README.md
  • start.png
  • table-component.png
  • user-form.png

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/wrannaman/generators

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

cd generators

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

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다.
npm i -g sugar-generate

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

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

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

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
docker build -f api/server/dockerFile.js -t generators .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 generators

빌드된 이미지를 실제 컨테이너로 실행합니다.

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

4. Node.js

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

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

npm i

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

npm run start

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

npm run dev

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

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

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

// repository documentation