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) #1614

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Conversation

stack-file[bot]
Copy link
Contributor

@stack-file stack-file bot commented Dec 21, 2023

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

Clivern/Walrus is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Clivern/Walrus is built on the following main stack:

- [Golang](http://golang.org/) – Languages
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) – Languages
- [Prometheus](http://prometheus.io/) – Monitoring Tools
- [Babel](http://babeljs.io/) – JavaScript Compilers
- [ESLint](http://eslint.org/) – Code Review
- [Vue.js](http://vuejs.org/) – Javascript UI Libraries
- [Gin Gonic](https://gin-gonic.com/) – Frameworks (Full Stack)
- [Protobuf](https://developers.google.com/protocol-buffers/) – Serialization Frameworks
- [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells
- [gRPC](https://grpc.io/) – Remote Procedure Call (RPC)
- [axios](https://github.com/mzabriskie/axios) – Javascript Utilities & Libraries
- [vuex](https://vuex.vuejs.org) – State Management Library
- [Testify](https://github.com/stretchr/testify) – Go Testing
- [Buefy](https://buefy.org/) – JavaScript Framework Components
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [Walrus](https://clivern.github.io/Walrus/) – Backup 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

Clivern/Walrus is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Clivern/Walrus 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/1209/javascript.jpeg' alt='JavaScript'/> [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) – 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/2739/-1wfGjNw.png' alt='Babel'/> [Babel](http://babeljs.io/) – JavaScript Compilers
- <img width='25' height='25' src='https://img.stackshare.io/service/3337/Q4L7Jncy.jpg' alt='ESLint'/> [ESLint](http://eslint.org/) – Code Review
- <img width='25' height='25' src='https://img.stackshare.io/service/3837/paeckCWC.png' alt='Vue.js'/> [Vue.js](http://vuejs.org/) – Javascript UI Libraries
- <img width='25' height='25' src='https://img.stackshare.io/service/4221/7894478.png' alt='Gin Gonic'/> [Gin Gonic](https://gin-gonic.com/) – Frameworks (Full Stack)
- <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/4670/default_d811b0ac72205af84aca21f967594338580be913.png' alt='gRPC'/> [gRPC](https://grpc.io/) – Remote Procedure Call (RPC)
- <img width='25' height='25' src='https://img.stackshare.io/no-img-open-source.png' alt='axios'/> [axios](https://github.com/mzabriskie/axios) – Javascript Utilities & Libraries
- <img width='25' height='25' src='https://img.stackshare.io/service/6705/6128107.png' alt='vuex'/> [vuex](https://vuex.vuejs.org) – State Management Library
- <img width='25' height='25' src='https://img.stackshare.io/service/8695/stretchr.png' alt='Testify'/> [Testify](https://github.com/stretchr/testify) – Go Testing
- <img width='25' height='25' src='https://img.stackshare.io/service/10410/26799900.png' alt='Buefy'/> [Buefy](https://buefy.org/) – JavaScript Framework Components
- <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/25030/default_0c26410cb3f142ddef70207666193eb3db35d0ab.png' alt='Walrus'/> [Walrus](https://clivern.github.io/Walrus/) – Backup 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)

Copy link

boring-cyborg bot commented Dec 21, 2023

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

@Clivern Clivern merged commit cb8ddd8 into main Dec 21, 2023
14 of 16 checks passed
@Clivern Clivern deleted the tech-stack-file branch December 21, 2023 15:32
Copy link

boring-cyborg bot commented Dec 21, 2023

Awesome work, congrats on your first merged pull request!

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