GitHub - koddr/template-go: The template repository for my next Go project. (original) (raw)
{{PROJECT}} – a small description
English | Русский | 简体中文 |Español
A full description for the {{PROJECT}} ...
Features:
- 100% free and open source under the Apache 2.0license;
- For any level of developer's knowledge and technical expertise;
- Well-documented, with a lot of tips and assists from the authors;
- ...
⚡️ Quick start
First, download and install Go. Version 1.21 (or higher) is required.
Now, you can use {{PROJECT}} without installation. Just go runit to create a new default config file:
go run github.com/koddr/{{PROJECT}}@latest init
Edit a config file with your settings and options.
Next, run a generation process to build Docker files to deploy your project:
go run github.com/koddr/{{PROJECT}}@latest generate
And now, deploy your project by the generated Dockerfile anddocker-compose.yml files in the current folder to the remote server.
👆 Tip: We are strongly recommended to use the awesomePortainer platform (or a self-hosted Community Edition) for the deploying process.
That's it! 🔥 A wonderful ...
🔹 A full Go-way to quick start
If you still want to install {{PROJECT}} CLI to your system by Golang, use thego install command:
go install github.com/koddr/{{PROJECT}}@latest
🍺 Homebrew-way to quick start
GNU/Linux and Apple macOS users available way to install {{PROJECT}} CLI viaHomebrew.
Tap a new formula:
Install to your system:
brew install koddr/tap/{{PROJECT}}
🐳 Docker-way to quick start
Feel free to using {{PROJECT}} CLI from ourofficial Docker image and run it in the isolated container:
docker run --rm -it -v PWD:{PWD}:PWD:{PWD} -w ${PWD} koddr/{{PROJECT}}:latest [COMMAND]
📦 Other way to quick start
Download ready-made exe files for Windows, deb, rpm, apk or Arch Linux packages from the Releases page.
📖 Complete user guide
To get a complete guide to use and understand the basic principles of the{{PROJECT}} CLI, we have prepared a comprehensive explanation of each command at once in this README file.
💬 From the authors: We always treasure your time and want you to start building really great web products on this awesome technology stack as soon as possible!
We hope you find answers to all of your questions! 👌 But, if you do not find needed information, feel free to create an issue or send aPR to this repository.
Don't forget to switch this page for your language (current isEnglish): Русский, 简体中文,Español.
init
Command to create a default config file (.{{PROJECT}}.yml) in the current folder.
Typically, a created config file contains the following options:
...
| Option name | Description |
|---|---|
| default | Use the ... |
🎯 Motivation to create
...
💬 From the authors: Earlier, we have already saved the world once, it wasCreate Go App (yep, that's our project too). TheGitHub stars statistics of this project can't lie: more than 2.2k developers of any level and different countries start a new project through this CLI tool.
🏆 A win-win cooperation
If you liked the {{PROJECT}} project and found it useful for your tasks, please click a 👁️ Watch button to avoid missing notifications about new versions, and give it a 🌟 GitHub Star!
It really motivates us to make this product even better.
...
And now, I invite you to participate in this project! Let's work together to create and popularize the most useful tool for developers on the web today.
- Issues: ask questions and submit your features.
- Pull requests: send your improvements to the current.
- Say a few words about the project on your social networks and blogs (Dev.to, Medium, Хабр, and so on).
Your PRs, issues & any words are welcome! Thank you 😘
🌟 Stargazers
...
⚠️ License
{{PROJECT}} is free and open-source software licensed under the Apache 2.0 License, created and supported byVic Shóstak with 🩵 for people and robots. Official logo distributed under the Creative Commons License (CC BY-SA 4.0 International).