Norwik / Helmet

🐺 A Lightweight Cloud Native API Gateway.
https://norwik.github.io/Helmet/
MIT License
131 stars 4 forks source link

Create tech stack docs (techstack.yml and techstack.md) #111

Closed stack-file[bot] closed 10 months ago

stack-file[bot] commented 10 months ago

Adding tech stack documentation to allow anyone to easily see what is being used in this repo without digging through config files. Two files are being added: techstack.yml and techstack.md. techstack.yml contains data on all the technologies being used in this repo. techstack.md is a visualization of the YML file and displays the tech stack data in a pretty Markdown file.

πŸ’‘ Protip: techstack.md contains a comment at the top of the file that the following README snippet (with and without the logos) at the top of the file as a comment:

<--- Readme.md Snippet without images Start --->

Tech Stack

Norwik/Helmet is built on the following main stack:

Full tech stack here

<--- Readme.md Snippet without images End --->

Get the code:

## Tech Stack
Norwik/Helmet is built on the following main stack:

- [Golang](http://golang.org/) – Languages
- [MySQL](http://www.mysql.com) – Databases
- [Redis](http://redis.io/) – In-Memory Databases
- [SQL](https://en.wikipedia.org/wiki/SQL) – Languages
- [Prometheus](http://prometheus.io/) – Monitoring Tools
- [Protobuf](https://developers.google.com/protocol-buffers/) – Serialization Frameworks
- [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells
- [Echo](https://echo.labstack.com) – Microframeworks (Backend)
- [GORM](https://gorm.io/) – Object Relational Mapper (ORM)
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers

Full tech stack [here](/techstack.md)

<--- Readme.md Snippet with images Start --->

Tech Stack

Norwik/Helmet is built on the following main stack:

Full tech stack here

<--- Readme.md Snippet with images End --->

Get the code:

## Tech Stack
Norwik/Helmet is built on the following main stack:

- <img width='25' height='25' src='https://img.stackshare.io/service/1005/O6AczwfV_400x400.png' alt='Golang'/> [Golang](http://golang.org/) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/1025/logo-mysql-170x170.png' alt='MySQL'/> [MySQL](http://www.mysql.com) – Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/1031/default_cbce472cd134adc6688572f999e9122b9657d4ba.png' alt='Redis'/> [Redis](http://redis.io/) – In-Memory Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/2271/default_068d33483bba6b81ee13fbd4dc7aab9780896a54.png' alt='SQL'/> [SQL](https://en.wikipedia.org/wiki/SQL) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/2501/default_3cf1b307194b26782be5cb209d30360580ae5b3c.png' alt='Prometheus'/> [Prometheus](http://prometheus.io/) – Monitoring Tools
- <img width='25' height='25' src='https://img.stackshare.io/service/4393/ma2jqJKH_400x400.png' alt='Protobuf'/> [Protobuf](https://developers.google.com/protocol-buffers/) – Serialization Frameworks
- <img width='25' height='25' src='https://img.stackshare.io/service/4631/default_c2062d40130562bdc836c13dbca02d318205a962.png' alt='Shell'/> [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells
- <img width='25' height='25' src='https://img.stackshare.io/service/4996/9P0MlumU_400x400.jpg' alt='Echo'/> [Echo](https://echo.labstack.com) – Microframeworks (Backend)
- <img width='25' height='25' src='https://img.stackshare.io/service/5194/default_c656a82cbf499a944563022a13ebbd62c9f3aa4b.png' alt='GORM'/> [GORM](https://gorm.io/) – Object Relational Mapper (ORM)
- <img width='25' height='25' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'/> [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- <img width='25' height='25' src='https://img.stackshare.io/service/586/n4u37v9t_400x400.png' alt='Docker'/> [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers

Full tech stack [here](/techstack.md)
boring-cyborg[bot] commented 10 months ago

Thanks for opening this pull request! Please check out our contributing guidelines.

boring-cyborg[bot] commented 10 months ago

Awesome work, congrats on your first merged pull request!