Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 4 commits into from

Conversation

stack-file[bot]
Copy link
Contributor

@stack-file stack-file bot commented Jan 5, 2024

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/Spacecraft is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Norwik/Spacecraft 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
- [Prometheus](http://prometheus.io/) – Monitoring Tools
- [Grafana](http://grafana.org/) – Monitoring Tools
- [Protobuf](https://developers.google.com/protocol-buffers/) – Serialization Frameworks
- [Echo](https://echo.labstack.com) – Microframeworks (Backend)
- [Alpine Linux](https://www.alpinelinux.org/) – Operating Systems
- [cURL](http://curl.haxx.se/) – File Transfer
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [Cloud DB for Mysql](https://www.ncloud.com/product/database/cloudDbMysql) – SQL Database as a Service
- [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers

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

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

Tech Stack

Norwik/Spacecraft is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Norwik/Spacecraft 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/2501/default_3cf1b307194b26782be5cb209d30360580ae5b3c.png' alt='Prometheus'/> [Prometheus](http://prometheus.io/) – Monitoring Tools
- <img width='25' height='25' src='https://img.stackshare.io/service/2645/default_8f9d552b144493679449b16c79647da5787e808b.jpg' alt='Grafana'/> [Grafana](http://grafana.org/) – 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/4996/9P0MlumU_400x400.jpg' alt='Echo'/> [Echo](https://echo.labstack.com) – Microframeworks (Backend)
- <img width='25' height='25' src='https://img.stackshare.io/service/6429/alpine_linux.png' alt='Alpine Linux'/> [Alpine Linux](https://www.alpinelinux.org/) – Operating Systems
- <img width='25' height='25' src='https://img.stackshare.io/service/6552/curl-logo.png' alt='cURL'/> [cURL](http://curl.haxx.se/) – File Transfer
- <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/21275/default_078eb0ae2b56280a937ed073a3ba4332291f9ba8.png' alt='Cloud DB for Mysql'/> [Cloud DB for Mysql](https://www.ncloud.com/product/database/cloudDbMysql) – SQL Database as a Service
- <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)

@Clivern Clivern closed this Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants