Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msfidelis/cloud-native-microservice-boilerplate
:package: :whale: :rocket: :zap: Personal project boilerplate to start new cloud native microservices projects with Go quickly
https://github.com/msfidelis/cloud-native-microservice-boilerplate
Last synced: 28 days ago
JSON representation
:package: :whale: :rocket: :zap: Personal project boilerplate to start new cloud native microservices projects with Go quickly
- Host: GitHub
- URL: https://github.com/msfidelis/cloud-native-microservice-boilerplate
- Owner: msfidelis
- License: mit
- Created: 2020-08-02T21:44:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-23T21:42:51.000Z (over 1 year ago)
- Last Synced: 2024-10-02T09:18:43.612Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 132 KB
- Stars: 13
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to Easy Golang API Bootstrap 👋
[](LICENSE)
[](https://twitter.com/fidelissauro)
> Project boilerplate to start new cloud native golang projects quickly
## How to start
1. Clone this boilerplate
```bash
git clone [email protected]:msfidelis/cloud-native-microservice-boilerplate.git
```
2. Change project name
> Use your CTRL + F or Search/Replace
* Search for `change-me` in project folder
* Change for your project name
## Developer mode (live reload with Air)
```sh
docker-compose up --force-recreate
```
```
change-me_1 |
change-me_1 | __ _ ___
change-me_1 | / /\ | | | |_)
change-me_1 | /_/--\ |_| |_| \_ v1.12.1 // live reload for Go apps, with Go1.14.0
change-me_1 |
change-me_1 | watching .
change-me_1 | watching configs
change-me_1 | watching controllers
change-me_1 | watching controllers/healthcheck
change-me_1 | watching controllers/version
change-me_1 | watching models
change-me_1 | watching models/foo
change-me_1 | watching pkg
change-me_1 | watching pkg/configuration
change-me_1 | watching pkg/system
change-me_1 | !exclude tmp
change-me_1 | building...
```
### Testing
```sh
curl 0.0.0.0:8080/version -i
```
```
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 02 Aug 2020 22:06:54 GMT
Content-Length: 16
{"version":"v1"}
```
## Unit Tests
```bash
ENVIRONMENT=test go test -v -cover
```
## Production Image
```sh
docker build -t newproject .
```
## Project Structure
```
.
├── Dockerfile (Production golang Dockerfile - Multistage Build)
├── Dockerfile.dev (Development golang Dockerfile - With Air)
├── LICENSE
├── README.md
├── configs (unsensitive configuration files)
│ ├── dev.json
│ ├── prod.json
│ └── test.json
├── controllers (controller folder)
│ ├── healthcheck (controller name / context)
│ │ └── main.go (main module for controller)
│ └── version
│ └── main.go
├── docker-compose.yml (docker-compose for development environment)
├── go.mod
├── go.sum
├── pkg (Shared libs folder)
│ ├── configuration (Lib Context / Name)
│ │ └── main.go (Main module for package)
│ └── system
│ └── main.go
└── main.go (Entrypoint / Routes)
```
## Features
### Chaos Monkey
This boilerplate works with a side-project called [gin-chaos-monkey](https://github.com/msfidelis/gin-chaos-monkey).
You can enable chaos assaults in your app setting some environment variables in runtime, like:
```yml
// ...
environment:
- ENVIRONMENT=dev
- CHAOS_MONKEY_ENABLED=true
- CHAOS_MONKEY_MODE=critical
- CHAOS_MONKEY_LATENCY=true
- CHAOS_MONKEY_EXCEPTION=false
- CHAOS_MONKEY_APP_KILLER=true
- CHAOS_MONKEY_MEMORY=false
```
You can enable assaults in production setting this variables in your platform cluster runtime. For more information, [read the docs](https://github.com/msfidelis/gin-chaos-monkey)!
### Swagger
Access Swagger in `http://0.0.0.0/swagger/index.html`
Swagger runs on production build on `Dockerfile`.
## Author
👤 **Matheus Fidelis**
* Website: https://raj.ninja
* Twitter: [@fidelissauro](https://twitter.com/fidelissauro)
* Github: [@msfidelis](https://github.com/msfidelis)
* LinkedIn: [@msfidelis](https://linkedin.com/in/msfidelis)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Matheus Fidelis](https://github.com/msfidelis).
This project is [MIT](LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_