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

Update tech stack docs (techstack.yml and techstack.md) #2

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

Conversation

stack-file[bot]
Copy link

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

kclhi/reflect is built on the following main stack:

  • JavaScript – Languages
  • Pug – Templating Languages & Extensions
  • TypeScript – Languages
  • Fastify – Microframeworks (Backend)
  • Node.js – Frameworks (Full Stack)
  • MongoDB – Databases
  • Mongoose – Object Document Mapper (ODM)
  • Chai – Javascript Testing Framework
  • Docker – Virtual Machine Platforms & Containers
  • ESLint – Code Review
  • Grunt – JS Build Tools / JS Task Runners
  • Mocha – Javascript Testing Framework
  • NGINX – Web Servers
  • Prettier – Code Review
  • Shell – Shells

Full tech stack here

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

Get the code:

## Tech Stack
kclhi/reflect is built on the following main stack:

- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) – Languages
- [Pug](https://pugjs.org) – Templating Languages & Extensions
- [TypeScript](http://www.typescriptlang.org) – Languages
- [Fastify](http://www.fastify.io/) – Microframeworks (Backend)
- [Node.js](http://nodejs.org/) – Frameworks (Full Stack)
- [MongoDB](http://www.mongodb.com/) – Databases
- [Mongoose](http://mongoosejs.com/) – Object Document Mapper (ODM)
- [Chai](http://chaijs.com/) – Javascript Testing Framework
- [Docker](https://www.docker.com/) – Virtual Machine Platforms & Containers
- [ESLint](http://eslint.org/) – Code Review
- [Grunt](http://gruntjs.com/) – JS Build Tools / JS Task Runners
- [Mocha](http://mochajs.org/) – Javascript Testing Framework
- [NGINX](http://nginx.org) – Web Servers
- [Prettier](https://prettier.io/) – Code Review
- [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells

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

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

Tech Stack

kclhi/reflect is built on the following main stack:

  • JavaScript JavaScript – Languages
  • Pug Pug – Templating Languages & Extensions
  • TypeScript TypeScript – Languages
  • Fastify Fastify – Microframeworks (Backend)
  • Node.js Node.js – Frameworks (Full Stack)
  • MongoDB MongoDB – Databases
  • Mongoose Mongoose – Object Document Mapper (ODM)
  • Chai Chai – Javascript Testing Framework
  • Docker Docker – Virtual Machine Platforms & Containers
  • ESLint ESLint – Code Review
  • Grunt Grunt – JS Build Tools / JS Task Runners
  • Mocha Mocha – Javascript Testing Framework
  • NGINX NGINX – Web Servers
  • Prettier Prettier – Code Review
  • Shell Shell – Shells

Full tech stack here

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

Get the code:

## Tech Stack
kclhi/reflect is built on the following main stack:

- <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/1175/pug.png' alt='Pug'/> [Pug](https://pugjs.org) – Templating Languages & Extensions
- <img width='25' height='25' src='https://img.stackshare.io/service/1612/bynNY5dJ.jpg' alt='TypeScript'/> [TypeScript](http://www.typescriptlang.org) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/7609/24939410.png' alt='Fastify'/> [Fastify](http://www.fastify.io/) – Microframeworks (Backend)
- <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/1030/leaf-360x360.png' alt='MongoDB'/> [MongoDB](http://www.mongodb.com/) – Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/1231/0TXzZU7W_400x400.jpg' alt='Mongoose'/> [Mongoose](http://mongoosejs.com/) – Object Document Mapper (ODM)
- <img width='25' height='25' src='https://img.stackshare.io/service/1725/chai.png' alt='Chai'/> [Chai](http://chaijs.com/) – Javascript Testing Framework
- <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/3337/Q4L7Jncy.jpg' alt='ESLint'/> [ESLint](http://eslint.org/) – Code Review
- <img width='25' height='25' src='https://img.stackshare.io/service/845/falgg2jybmhgk16y62lr.png' alt='Grunt'/> [Grunt](http://gruntjs.com/) – JS Build Tools / JS Task Runners
- <img width='25' height='25' src='https://img.stackshare.io/service/832/mocha.png' alt='Mocha'/> [Mocha](http://mochajs.org/) – Javascript Testing Framework
- <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/7035/default_66f265943abed56bcdbfca1c866a4261b1fbb063.jpg' alt='Prettier'/> [Prettier](https://prettier.io/) – Code Review
- <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