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

Closed
wants to merge 3 commits into from

Conversation

stack-file[bot]
Copy link

@stack-file stack-file bot commented Dec 14, 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

sonrhq/sonr is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
sonrhq/sonr is built on the following main stack:

- [Golang](http://golang.org/) – Languages
- [Node.js](http://nodejs.org/) – Frameworks (Full Stack)
- [NGINX](http://nginx.org) – Web Servers
- [Rust](http://www.rust-lang.org/) – Languages
- [Prometheus](http://prometheus.io/) – Monitoring Tools
- [Codecov](https://codecov.io/) – Code Coverage
- [Visual Studio Code](https://code.visualstudio.com/) – Text Editor
- [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)
- [Testify](https://github.com/stretchr/testify) – Go Testing
- [Google Cloud Build](https://cloud.google.com/cloud-build) – Continuous Deployment
- [OpenCensus](https://opencensus.io/) – Monitoring Tools
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [LangChain](https://github.com/hwchase17/langchain) – Large Language Model Tools
- [pgvector](https://github.com/pgvector/pgvector/) – Database Tools
- [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers

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

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

Tech Stack

sonrhq/sonr is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
sonrhq/sonr 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/1011/n1JRsFeB_400x400.png' alt='Node.js'/> [Node.js](http://nodejs.org/) – Frameworks (Full Stack)
- <img width='25' height='25' src='https://img.stackshare.io/service/1052/YMxUfyWf.png' alt='NGINX'/> [NGINX](http://nginx.org) – Web Servers
- <img width='25' height='25' src='https://img.stackshare.io/service/1070/v7txhrjp9pdqrkdtxxp0.png' alt='Rust'/> [Rust](http://www.rust-lang.org/) – 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/2673/Codecov_Mark_Circle_Pink.png' alt='Codecov'/> [Codecov](https://codecov.io/) – Code Coverage
- <img width='25' height='25' src='https://img.stackshare.io/service/4202/Visual_Studio_Code_logo.png' alt='Visual Studio Code'/> [Visual Studio Code](https://code.visualstudio.com/) – Text Editor
- <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/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/9309/PoHJY3K8_400x400.jpg' alt='Google Cloud Build'/> [Google Cloud Build](https://cloud.google.com/cloud-build) – Continuous Deployment
- <img width='25' height='25' src='https://img.stackshare.io/service/10794/EpBd2Xrw_400x400.jpg' alt='OpenCensus'/> [OpenCensus](https://opencensus.io/) – Monitoring Tools
- <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/48790/default_5b6c6b73f1ff3775c85d2a1ba954cb87e30cbf13.jpg' alt='LangChain'/> [LangChain](https://github.com/hwchase17/langchain) – Large Language Model Tools
- <img width='25' height='25' src='https://img.stackshare.io/service/109221/default_b888cdf5617d936aa6aacf130911906955508639.png' alt='pgvector'/> [pgvector](https://github.com/pgvector/pgvector/) – Database Tools
- <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

Please follow naming conventions! 😿

Copy link

sweep-ai bot commented Dec 14, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@prnk28 prnk28 closed this Dec 16, 2023
@prnk28 prnk28 deleted the tech-stack-file branch December 18, 2023 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants