easy-project-setup v1.2.18

Easy Project Setup

Easily setup and deploy projects

Introduce

이 프로젝트는 오래된 프로젝트의 개발 환경을 관리하고, 손쉽게 설정하기 위하여 개발되었습니다.
개발자뿐 아니라 PM, 디자이너, 퍼블리셔 등을 위한 프로젝트입니다.

This project was developed to manage the development environment of the old project and set it up easily. This project is not only for developers, but also for PMs, designers, publishers, etc.

How to use

Project Root Path에 project.setup.json 파일을 만듭니다.
Create project.setup.json file in Project Root Path.

{
  "develop": [
    {
      "name": "test-backend",
      "type": "git",
      "language": {
        "type": "nodejs",
        "tool": "yarn",
        "nvm": 16
      },
      "repository": "{GIT_URL}",
      "branch": "develop",
      "runCommand": "yarn start:dev"
    },
    {
      "name": "test-front",
      "type": "git",
      "language": {
        "type": "nodejs",
        "tool": "yarn",
        "nvm": 16
      },
      "repository": "{GIT_URL}",
      "branch": "master",
      "runCommand": "yarn dev"
    },
    {
      "name": "test-docker",
      "type": "docker",
      "dockerCompose": {
        "path": "./docker-compose.yml",
        "options": "-d"
      },
      "env": [{
        "fileName": ".env",
        "path": "./",
        "data": {
          "ENV_DATA": "ENV DATA"
        }
      }]
    }
  ],
  "release": [
    {
      "name": "test-docker",
      "type": "docker",
      "dockerCompose": {
        "path": "./docker-compose.yml",
        "options": "-d"
      },
      "env": [
        {
          "fileName": ".env",
          "path": "./",
          "data": {
            "MAIL_HOST": "smtp.gmail.com",
            "MAIL_PORT": 587,
            "MAIL_SECURE": false,
            "MAIL_USER": "",
            "MAIL_PASS": "",
            "MAIL_SERVICE": "gmail"
          }
        }
      ]
    }
  ],
  "deploy": [
    {
      "name": "test-front",
      "type": "ssh",
      "targetProject": { "target": "develop", "project": "test-front" }, //Above Project Infomation
      "dockerFile": { //Docker Build Infomation
        "path": "./",
        "args": {},
        "tag": "${DOCKER TAG}",
        "push": true
      },
      "dockerComposeFile": { // Upload docker-compose file to Remote from local
        "path": "./",
        "fileName": "./docker-compose.yml",
        "conatainerName": "${YOUR CONTAINER NAME}",
        "repository": {
          "user": "",
          "password": "",
          "host": ""
        }
      },
      "remoteTarget": { // SSH Infomation
        "host": "",
        "port": "",
        "user": "",
        "path": ""
      },
      "shellCommand": [""], // Last execute
      "env": { //Generate Env Remote Folder
        "fileName": ".env",
        "path": "./"
      }
    }
  ]
}

Project Setup

프로젝트 설정을 진행합니다.
Proceed with project setup.

npx easy-project-setup setup {target}
//npx easy-project-setup setup develop

Project Start

개별 프로젝트를 실행합니다.
Run individual projects.

npx easy-project-setup start {target} {project-name}
//npx easy-projeect-setup start develop test-front

Project Stop

개별 프로젝트를 중지합니다.
Stop individual projects.

npx easy-project-setup stop {target} {project-name}
//npx easy-projeect-setup stop develop test-front