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! The CLI will take care of the rest.

    

⚡️ Quick start

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

Installation is done by using the go build command with $GOPATH/bin:

go build -i -o $GOPATH/bin/cgapp github.com/create-go-app/cli

Let's create a new project into ./app folder with Fiber as backend and Nginx as web server:

cgapp create -p ./app -b fiber -w nginx

Okay, it works! Now, you can deploy this project to a remote server or run on your local machine in isolated Docker containers. Go to the root project folder and type command:

cgapp deploy -u john_doe --ask-become-pass

That's all you need to start! 🎉

📖 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.

🔥 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
    • create
    • deploy
  • 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

create

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

cgapp create -p <PATH> -b <BACKEND> -f <FRONTEND> -w <WEBSERVER> -d <DB>

Option	Argument	Required?	Description	Default value
-p	PATH	no	path to create project	current folder, ./
-b	BACKEND	no	backend for your project	net/http
-f	FRONTEND	no	frontend for your project
-w	WEBSERVER	no	web/proxy server for your project
-d	DB	no	database for your project

deploy

CLI command for deploy Docker containers with your project to a remote server or run on your local machine.

cgapp deploy -p <PLAYBOOK> -u <USER> -s <HOST> -n <NETWORK> [ARGS...]

Option	Argument	Required?	Description	Default value
-p	PLAYBOOK	no	the Ansible playbook name	deploy-playbook.yml
-u	USER	yes	an username of remote's server or local's user
-s	HOST	no	a host name from your inventory file	localhost
-n	NETWORK	no	a network name for your Docker containers	cgapp_network

If you need to deploy (or run) a project asking for a password for the USER, simply add an --ask-become-pass argument in [ARGS...] section.

📝 Production-ready project templates

Golang:

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

JavaScript:

• react-js — Frontend template with React.js.
• preact — Frontend template with Preact.

TypeScript:

• react-ts — Frontend template with React.js TypeScript.

🐳 Configured Docker containers

Web/Proxy server:

• nginx — Docker container with Nginx.

Database:

• postgres WIP — Docker container with PostgreSQL.

⭐️ 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.
• Donate some money to the project's author via PayPal: @paypal.me/koddr.

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).