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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

stack-file[bot]
Copy link

@stack-file stack-file bot commented Jun 23, 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

Xcov19/registrations is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Xcov19/registrations is built on the following main stack:

- [Python](https://www.python.org) – Languages
- [FastAPI](https://fastapi.tiangolo.com/) – Microframeworks (Backend)
- [DB](https://github.com/infostreams/db) – Database Tools
- [MongoDB](http://www.mongodb.com/) – Databases
- [PostgreSQL](http://www.postgresql.org/) – Databases
- [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells

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

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

Tech Stack

Xcov19/registrations is built on the following main stack:

Full tech stack here

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

Get the code:

## Tech Stack
Xcov19/registrations is built on the following main stack:

- <img width='25' height='25' src='https://img.stackshare.io/service/993/pUBY5pVj.png' alt='Python'/> [Python](https://www.python.org) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/25014/default_f6ff39141b468e832d1bc59fc98a060df604d44d.png' alt='FastAPI'/> [FastAPI](https://fastapi.tiangolo.com/) – Microframeworks (Backend)
- <img width='25' height='25' src='https://img.stackshare.io/service/11593/no-img.png' alt='DB'/> [DB](https://github.com/infostreams/db) – Database Tools
- <img width='25' height='25' src='https://img.stackshare.io/service/1030/leaf-360x360.png' alt='MongoDB'/> [MongoDB](http://www.mongodb.com/) – Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/1028/ASOhU5xJ.png' alt='PostgreSQL'/> [PostgreSQL](http://www.postgresql.org/) – Databases
- <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
- <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/4631/default_c2062d40130562bdc836c13dbca02d318205a962.png' alt='Shell'/> [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant