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

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

Conversation

stack-file[bot]
Copy link

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

lucasportella/blogs-api is built on the following main stack:

  • JavaScript – Languages
  • ExpressJS – Microframeworks (Backend)
  • Node.js – Frameworks (Full Stack)
  • MySQL – Databases
  • Sequelize – Object Relational Mapper (ORM)
  • Chai – Javascript Testing Framework
  • ESLint – Code Review
  • GitHub Actions – Continuous Integration
  • Jest – Javascript Testing Framework
  • Mocha – Javascript Testing Framework
  • SinonJS – Javascript Testing Framework
  • SuperTest – Javascript Testing Framework
  • Yarn – Front End Package Manager
  • nodemon – node.js Application Monitoring

Full tech stack here

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

Get the code:

## Tech Stack
lucasportella/blogs-api is built on the following main stack:

- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) – Languages
- [ExpressJS](http://expressjs.com/) – Microframeworks (Backend)
- [Node.js](http://nodejs.org/) – Frameworks (Full Stack)
- [MySQL](http://www.mysql.com) – Databases
- [Sequelize](https://sequelize.org/) – Object Relational Mapper (ORM)
- [Chai](http://chaijs.com/) – Javascript Testing Framework
- [ESLint](http://eslint.org/) – Code Review
- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
- [Jest](http://facebook.github.io/jest/) – Javascript Testing Framework
- [Mocha](http://mochajs.org/) – Javascript Testing Framework
- [SinonJS](http://sinonjs.org/) – Javascript Testing Framework
- [SuperTest](https://www.npmjs.com/package/supertest) – Javascript Testing Framework
- [Yarn](https://yarnpkg.com/) – Front End Package Manager
- [nodemon](http://nodemon.io/) – node.js Application Monitoring

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

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

Tech Stack

lucasportella/blogs-api is built on the following main stack:

  • JavaScript JavaScript – Languages
  • ExpressJS ExpressJS – Microframeworks (Backend)
  • Node.js Node.js – Frameworks (Full Stack)
  • MySQL MySQL – Databases
  • Sequelize Sequelize – Object Relational Mapper (ORM)
  • Chai Chai – Javascript Testing Framework
  • ESLint ESLint – Code Review
  • GitHub Actions GitHub Actions – Continuous Integration
  • Jest Jest – Javascript Testing Framework
  • Mocha Mocha – Javascript Testing Framework
  • SinonJS SinonJS – Javascript Testing Framework
  • SuperTest SuperTest – Javascript Testing Framework
  • Yarn Yarn – Front End Package Manager
  • nodemon nodemon – node.js Application Monitoring

Full tech stack here

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

Get the code:

## Tech Stack
lucasportella/blogs-api 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/1163/hashtag.png' alt='ExpressJS'/> [ExpressJS](http://expressjs.com/) – 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/1025/logo-mysql-170x170.png' alt='MySQL'/> [MySQL](http://www.mysql.com) – Databases
- <img width='25' height='25' src='https://img.stackshare.io/service/3211/3591786.png' alt='Sequelize'/> [Sequelize](https://sequelize.org/) – Object Relational Mapper (ORM)
- <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/3337/Q4L7Jncy.jpg' alt='ESLint'/> [ESLint](http://eslint.org/) – Code Review
- <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/830/jest.png' alt='Jest'/> [Jest](http://facebook.github.io/jest/) – Javascript Testing Framework
- <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/3509/logo.png' alt='SinonJS'/> [SinonJS](http://sinonjs.org/) – Javascript Testing Framework
- <img width='25' height='25' src='https://img.stackshare.io/no-img-open-source.png' alt='SuperTest'/> [SuperTest](https://www.npmjs.com/package/supertest) – Javascript Testing Framework
- <img width='25' height='25' src='https://img.stackshare.io/service/5848/44mC-kJ3.jpg' alt='Yarn'/> [Yarn](https://yarnpkg.com/) – Front End Package Manager
- <img width='25' height='25' src='https://img.stackshare.io/service/5577/preview.png' alt='nodemon'/> [nodemon](http://nodemon.io/) – node.js Application Monitoring

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