README.md

JoATMoN

JoATMoN - Jack of All Trades, Master of None (Manja de Tudo, Mestre de Nada)

Uma api para criar mini recursos como pequenos conversores, contadores, validadores, calculadoras, etc, como um canivete sui'co 😉

Esse readme.md bem como a Wiki serão em pt-br para facilitar a utilização de novos devs que falam português. Só defini o nome como JoATMoN, em inglês, porque adoro Digimon, Pokémon e outras séries mon ❤️👾❤️

en-us version: This readme.md as well as the Wiki will be in pt-br to facilitate the use of new devs who speak Portuguese. I only defined the name as JoATMoN, in English, because I love Digimon, Pokémon and other series mon ❤️👾❤️

Demo

Insert gif or link to demo

Capturas de Telas

Usado por

Esse projeto é usado pelas seguintes empresas/times/personalidades:

• @luisangelorjr
• larjr | A Consultoria do Luís. Um lar para Juniors
• Hacho | Like a Software House But a SaaS House
• Handagar | Game Studios
• Nem Na Minha Casa | Art Studios
• Teatro Cyro Ferreira Lima
• Biblioteca Maria Brasilina

Features

TODO: Traduzir e adaptar

• Light/dark mode toggle
• Live previews
• Fullscreen mode
• Cross platform

Documentaçao

https://github.com/larjr/joatmon/wiki

API

• OpenAPI localhost
• OpenAPI QA
• OpenAPI PROD

Tech Stack

Cliente/FrontEnd: VsCode

Servidor/BackEnd: Java, Spring, Eclipse

Infraestrutura: Github, Github Actions, AWS, EC2.

Executar localmente

TODO: Traduzir e adaptar

Clone the project

  git clone https://link-to-project

Go to the project directory

  cd my-project

Install dependencies

  npm install

Start the server

  npm run start

Variáveis de Ambiente

TODO: Traduzir e adaptar

To run this project, you will need to add the following environment variables to your .env file

API_KEY

ANOTHER_API_KEY

Rodando testes

TODO: Traduzir e adaptar

To run tests, run the following command

  npm run test

Deploy

TODO: Traduzir e adaptar

To deploy this project run

  npm run deploy

Instalaçao

TODO: Traduzir e adaptar

Install my-project with npm

  npm install my-project
  cd my-project

Roadmap

• Terminar o fluxo CI/CD
• Templates para issues/pull requests e etc.
• Definir ambientes (dev/local, QA, PROD)
• Documentar de forma fácil para que os mentorados e futuros tenham um início muuuuito fácil
• Definir e criar o front

Liçoes aprendidas

What did you learn while building this project? What challenges did you face and how did you overcome them?

Otimizaçoes

TODO: Traduzir e adaptar

What optimizations did you make in your code? E.g. refactors, performance improvements, accessibility

Projetos Relacionados

Esses são outros projetos que tem relações com esse:

Awesome README

Autores

• @luisangelorjr

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

FAQ

TODO: Traduzir e adaptar

Question 1

Answer 1

Question 2

Answer 2

Feedback

Se você tem algum feedback, pode me mandar um e-mail em luisangelorjr@gmail.com OU abrir uma issue aqui no repositório 😉

Suporte

Para suporte na utilização/consumo da API ou em algo relacionado ao projeto, pode me mandar um e-mail em luisangelorjr@gmail.com OU abrir uma issue aqui no repositório 😉

Agradecimentos

• Awesome Readme Templates
• Awesome README
• How to write a Good readme
• The easiest way to create a README
• A comunidade perifaCode que me ajudou, ajuda e ajudará

License

MIT

---