cli

README

Create Go App CLI

Create a new production-ready project with backend (Golang), frontend (JavaScript, TypeScript)
and deploy automation (Ansible, Docker) by running one CLI command.

Focus on writing code and thinking of business-logic! The CLI will take care of the rest.

    

⚡️ Quick start

First of all, download and install Go. Version 1.16 or higher is required.

Installation is done by using the go install command and rename installed binary in $GOPATH/bin:

go install -ldflags="-s -w" github.com/create-go-app/cli && mv $GOPATH/bin/cli $GOPATH/bin/cgapp

Also, macOS and GNU/Linux users available way to install via Homebrew:

# Tap a new formula:
brew tap create-go-app/cli

# Installation:
brew install create-go-app/cli/cgapp

Let's create a new project via interactive console UI (or CUI for short) into current folder:

cgapp create

Okay, it works! Now, you can run this project on your local machine or deploy to a remote server. Project works in isolated Docker containers and automates via Ansible playbook:

cgapp deploy

That's all you need to start! 🎉

~ Docker-way to quick start

If you don't want to install Create Go App CLI to your system, you feel free to using our official Docker image and run CLI from isolated container:

docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} koddr/cgapp:latest

With this Docker image, you do not have to worry about installing tools/CLI of frontend UI libraries/frameworks. Everything is already included: create-react-app, preact-cli, vue-cli, ng-cli and degit (for Svelte and Sapper).

Available commands for official Docker image:

• init
• create

🔔 Please note: a deploy command is currently unavailable in this image.

📺 Video screencast

A short video screencast to introduce main features of the Create Go App CLI.

🔗 https://youtu.be/5-DNZFU9TOQ

📖 Official Documentation

Unfortunately, we are unable to include all helpful documentation to the README file. That's why, the best way to better explore all the features of the Create Go App CLI is to read the Official Documentation and explore Discussions.

🔥 We've put together a subject index specifically for you, so you can find any answer you want in seconds!

• Detailed guides
  • CLI Installation
    • Alternative installations
  • Understanding CLI commands and options
    • init
    • create
    • deploy
  • Working with the official Docker image
  • Run project on your local machine
  • Deploy project to a production server
  • Make your own template
  • Make your own container
• FAQ
  • Automation of a deploy process
  • How do I ask the right question?
• Official logo

⚙️ Commands & Options

init

CLI command for generate a default .cgapp.yml config file in current folder:

cgapp init

• 📺 Preview: https://recordit.co/yvlnIu8Lyp
• 📖 Docs: https://create-go.app/detailed-guides/commands-and-options/#init

Generated config file

# Project config.
project:
  # Backend for your project.
  # (Required)
  # String:
  #   - `net/http`
  #   - `fiber`
  # User template: supported, set to URL (without protocol),
  # like `github.com/user/template`
  - backend: fiber

  # Frontend for your project.
  # (Optional, to skip set to `none`)
  # String:
  #   - `react`
  #     - `react:<template>`
  #   - `preact`
  #     - `preact:<template>`
  #   - `vue`
  #     - `vue:<user/repo>` (for preset from GitHub)
  #     - `vue:<gitlab|bitbucket>:<user/repo>` (for presets from others)
  #   - `angular`
  #   - `svelte`
  #   - `sapper`
  #     - `sapper:<webpack>`
  # User template: supported, set to URL (without protocol),
  # like `github.com/user/template`
  - frontend: svelte

  # Web/Proxy server for your project.
  # (Optional, to skip set to `none`)
  # String: `nginx`
  # User template: supported, set to URL (without protocol),
  # like `github.com/user/template`
  - webserver: nginx

# Automation config.
roles:
  # Ansible roles for deploy your project.
  # (Optional, to skip set to empty or comment)
  # Objects list.
  - deploy:
    # Username of remote's server or local's user.
    # (Required)
    username: root

    # If you need to deploy (or run) a project asking for a password
    # for the user, set `become` to `true`. This is equivalent of
    # `--ask-become-pass`, a standard Ansible argument
    # to ask for a privilege escalation password.
    # (Optional)
    become: true

    # Host name from your inventory file (usually, at /etc/ansible/hosts).
    # (Required)
    host: localhost

    # Name of Docker network
    # (Required)
    network: cgapp_network

    # Port for backend Docker container (both in and out).
    # (Required)
    backend_port: 5000

    # Filename of Ansible playbook in the root of the Create Go App project.
    # If you want to rename it, do it, but not to change destination of file!
    # (Required)
    playbook: deploy-playbook.yml

create

CLI command to create a new project with the selected configuration.

There's two ways to create a new project:

• With an interactive console UI (or CUI).
• From configuration file (by default, in $PWD/.cgapp.yml).

Create with the interactive console UI

Run create command without any arguments:

cgapp create

• 📺 Preview: https://recordit.co/LTxFQloedn
• 📖 Docs: https://create-go.app/detailed-guides/commands-and-options/#create

Create from the config file

Run create command with --use-config (or -c) argument:

cgapp create --use-config

deploy

CLI command for deploy Docker containers with your project to a remote server.

☝️ You should only run this command from the root folder of your project, which created with the cgapp create command! It's a necessary condition for everything to work perfectly.

There's, also, two ways to deploy your project:

• With an interactive console UI (or CUI).
• From configuration file (by default, in $PWD/.cgapp.yml).

Deploy with the interactive console UI

Run deploy command without any arguments:

cgapp deploy

• 📺 Preview: https://recordit.co/ewjG9dgMPX
• 📖 Docs: https://create-go.app/detailed-guides/commands-and-options/#deploy

Deploy from the config file

Run deploy command with --use-config (or -c) argument:

cgapp deploy --use-config

🤔 Why another CLI?

When we started this project, we asked ourselves this question too and... came to the conclusion, that approximately 8 out of 10 routine operations at the start of a new project and/or the deployment of an existing one can be automated. And it would be better to have all the necessary functions inside one CLI. That's why we transferred all our experience to the Create Go App CLI, which we use ourselves!

So, yes, this CLI gives you the ability to prepare everything you need to start a new project (as create-react-app for the React.js ecosystem does) and deploy an existing project to a remote server in configured and fully isolated Docker containers.

📝 Production-ready project templates

Backend:

• net/http — Backend template with Golang built-in net/http package.
• fiber — Backend template with Fiber.
• echo (WIP) — Backend template with Echo.
• gin (WIP) — Backend template with Gin.

Frontend:

• react — React frontend app.
  • react:<template> — CRA generated template for React app.
• preact — Preact frontend app.
  • preact:<template> — Preact CLI generated template for Preact app.
• vue — Vue.js frontend app.
  • vue:<user/repo> — Preset for generating Vue.js app from GitHub.
  • vue:<gitlab|bitbucket>:<user/repo> — Preset for generating Vue.js app from GitLab/BitBucket/etc.
• angular — Angular frontend app.
• svelte — Svelte frontend app.
• sapper — Sapper frontend app for static websites.
  • sapper:<webpack> — Preset for generating Sapper with Webpack bundler.

☝️ Please note, that since version v1.3.0, frontend templates (in the classical sense) are not supported by the Create Go App CLI. Those templates, that we created (react-js, react-ts and preact-js), are still available, but only for use as user's custom templates.

Now, the frontend part of your project will be generated using official CLI from the authors of each frontend UI library/framework (under the hood). So, you'll always get the latest version of React, Preact, Vue.js, Angular, Svelte or Sapper for your project from their authors!

🐳 Configured Docker containers

Web/Proxy server:

• nginx — Docker container with Nginx.

👤 Custom templates & containers?

Create Go App CLI provide works with your own custom templates, instead of those prepared by authors. Just specify backend, frontend and webserver with addresses to repositories in configuration file (.cgapp.yml):

project:
  - backend: github.com/user1/my-template-1
  - frontend: gitlab.com/user2/my-template-2
  - webserver: bitbucket.org/user3/my-template-3
# ...

☝️ The https:// protocol will be added automatically!

👵 How to install older version?

You can do it by using a version suffix in go install command:

go install github.com/create-go-app/cli@1.6.0

☝️ Don't forget to rename binary after installation, according to the version you have installed! This must be done to avoid confusion with the latest version.

For example: mv $GOPATH/bin/cli $GOPATH/bin/cgapp_v1_6_0 and run it by cgapp_v1_6_0.

Found all available CLI versions on our pkg.go.dev page.

⭐️ Project assistance

If you want to say thank you or/and support active development of Create Go App CLI:

• Add a GitHub Star to the project.
• Twit about project on your Twitter.
• Write interesting articles about project on Dev.to, Medium or personal blog.
• Join DigitalOcean at our referral link (your profit is $100 and we get $25).

Together, we can make this project better every day! 😘

⚠️ License

Create Go App CLI is free and open-source software licensed under the Apache 2.0 License. Official logo was created by Vic Shóstak and distributed under Creative Commons license (CC BY-SA 4.0 International).

Documentation

Overview

Package main includes call for the Create Go App CLI.

Create a new production-ready project with backend (Golang), frontend (JavaScript, TypeScript) and deploy automation (Ansible, Docker) by running one CLI command.

-> Focus on writing code and thinking of business logic! <- The Create Go App CLI will take care of the rest.

A helpful documentation and next steps -> https://create-go.app/

Copyright (c) 2019-present Vic Shóstak <vic@shostak.dev> (https://shostak.dev)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.