init repo
This commit is contained in:
commit
7873f5defa
112
README.md
Normal file
112
README.md
Normal file
@ -0,0 +1,112 @@
|
||||
# CloudMandala
|
||||
|
||||
<img style="margin-top: 1em;width: 500px;border: 0" alt="Fork me on GitHub" src="logo/cloudmandala.svg?sanitize=true">
|
||||
|
||||
## Declarative Cloud command line interface
|
||||
|
||||
This was created to:
|
||||
|
||||
|
||||
## Requirements for build
|
||||
|
||||
## Build from source
|
||||
|
||||
- Clone this repository and go to folder:
|
||||
|
||||
```bash
|
||||
git clone
|
||||
cd upclapi
|
||||
```
|
||||
|
||||
- Build:
|
||||
|
||||
```bash
|
||||
cargo build
|
||||
```
|
||||
|
||||
- Install ():
|
||||
|
||||
```bash
|
||||
```
|
||||
|
||||
#### Run examples
|
||||
|
||||
Use evironment variables like this:
|
||||
|
||||
```bash
|
||||
```
|
||||
|
||||
If creadentials are not found, this message will be displayed:
|
||||
|
||||
```txt
|
||||
```
|
||||
|
||||
As an option it is possible to encrypt sensitive informations like:
|
||||
|
||||
- Credentials (username/password)
|
||||
- Data config file in yaml
|
||||
|
||||
- Help
|
||||
|
||||
```bash
|
||||
# Getting help
|
||||
```
|
||||
|
||||
```txt
|
||||
```
|
||||
|
||||
- That's all! 🎉
|
||||
|
||||
## YAML Config Example
|
||||
|
||||
```yaml
|
||||
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
Main vars:
|
||||
|
||||
|
||||
Use to preset settings:
|
||||
|
||||
| Arg | Env. var |
|
||||
|---|---|
|
||||
|
||||
## Coders and encoders
|
||||
|
||||
It is possible to encrypt sensitive informations like:
|
||||
|
||||
- Credentials (username/password)
|
||||
- Data config file in yaml
|
||||
|
||||
Coders are called using operating system command (exec)
|
||||
|
||||
> [Tecoder]() from [ZTerton]()
|
||||
> backend developments is fully supported
|
||||
|
||||
Coder definition to be used:
|
||||
| var | content |
|
||||
|---|---|
|
||||
| cmd | command-path |
|
||||
|
||||
## Author
|
||||
|
||||
- [Jesús Pérez](https://github.com/jesusperez).
|
||||
|
||||
## Article assistance
|
||||
|
||||
If you want to say «thank you»:
|
||||
|
||||
1. Twit about article [on your Twitter](https://twitter.com/intent/tweet?text=Let%27s%20write%20config%20for%20your%20Golang%20web%20app%20on%20right%20way%20%E2%80%94%20YAML%20%F0%9F%91%8C%20https%3A%2F%2Fdev.to%2Fkoddr%2Flet-s-write-config-for-your-golang-web-app-on-right-way-yaml-5ggp).
|
||||
2. Add a GitHub Star and make Fork to this repository.
|
||||
3. Donate some money to project author via PayPal: [@paypal.me/](https://paypal.me/).
|
||||
4. Join UpCloud at my [referral link](https://upcloud.com/signup/?promo=CVR337) (your profit is **\$25** credits and I will receive \$50 worth of free credits).
|
||||
|
||||
Thanks for your support! 😘
|
||||
|
||||
## References
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
Loading…
Reference in New Issue
Block a user