Challenge Bravo

.dockerignore

@@ -0,0 +1,9 @@
+node_modules
+npm-debug.log
+.DS_Store
+.git
+.gitignore
+.env
+notes.txt
+mysql_data
+sql

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+package-lock.json
+notes.txt
+.env
+mysql_data

Dockerfile.backend

@@ -0,0 +1,7 @@
+FROM node:18
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+EXPOSE 3000
+CMD ["npm", "start"]

Dockerfile.worker

@@ -0,0 +1,7 @@
+FROM node:18
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY models/ models/
+COPY workers/ workers/
+CMD ["node", "workers/currencys.js"]

README.md

@@ -1,82 +1,106 @@
 # <img src="https://avatars1.githubusercontent.com/u/7063040?v=4&s=200.jpg" alt="Hurb" width="24" /> Bravo Challenge
 
-[[English](README.md) | [Portuguese](README.pt.md)]
+Para esse desafio foi usada a seguinte arquitetura:
 
-Build an API, which responds to JSON, for currency conversion. It must have a backing currency (USD) and make conversions between different currencies with **real and live values**.
+<p>
+    <img src="./docs/Architecture.png" alt="Architecture" />
+</p>
 
-The API must convert between the following currencies:
+## Diagramas de sequência
 
--   USD
--   BRL
--   EUR
--   BTC
--   ETH
+### Worker
 
-Other coins could be added as usage.
+<p>
+    <img src="./docs/Sequence-Worker.png" alt="[UML] Sequence - Worker" />
+</p>
 
-Ex: USD to BRL, USD to BTC, ETH to BRL, etc...
+### API
 
-The request must receive as parameters: The source currency, the amount to be converted and the final currency.
+<p>
+    <img src="./docs/Sequence-API.png" alt="[UML] Sequence - Worker" />
+</p>
 
-Ex: `?from=BTC&to=EUR&amount=123.45`
+## Containers (docker):
 
-Also build an endpoint to add and remove API supported currencies using HTTP verbs.
+### db
 
-The API must support conversion between FIAT, crypto and fictitious. Example: BRL->HURB, HURB->ETH
+Banco de dados MySQL responsável por persistir os dados em um estado sólido.
 
-"Currency is the means by which monetary transactions are effected." (Wikipedia, 2021).
+### redis
 
-Therefore, it is possible to imagine that new coins come into existence or cease to exist, it is also possible to imagine fictitious coins such as Dungeons & Dragons coins being used in these transactions, such as how much is a Gold Piece (Dungeons & Dragons) in Real or how much is the GTA$1 in Real.
+Banco de dados em memória (volátil) que dará melhor desempenho e velocidade em nosso response.
 
-Let's consider the PSN quote where GTA$1,250,000.00 cost R$83.50 we clearly have a relationship between the currencies, so it is possible to create a quote. (Playstation Store, 2021).
+### worker
 
-Ref:
-Wikipedia [Institutional Website]. Available at: <https://pt.wikipedia.org/wiki/Currency>. Accessed on: 28 April 2021.
-Playstation Store [Virtual Store]. Available at: <https://store.playstation.com/pt-br/product/UP1004-CUSA00419_00-GTAVCASHPACK000D>. Accessed on: 28 April 2021.
+Serviço responsável por manter o db e o redis sempre atualizados com dados reais. O tempo de atualização default é de 5 minutos, porém esse parâmetro pode ser alterado atualizando o docker-compose.yml
 
-You can use any programming language for the challenge. Below is the list of languages ​​that we here at Hurb have more affinity:
+### app
 
--   JavaScript (NodeJS)
--   Python
--   Go
--   Ruby
--   C++
--   PHP
+Nosso servidor backend escrito em NodeJS utilizando o framework [ExpressJS](https://expressjs.com/pt-br/).
 
-## Requirements
 
--   Fork this challenge and create your project (or workspace) using your version of that repository, as soon as you finish the challenge, submit a _pull request_.
-    -   If you have any reason not to submit a _pull request_, create a private repository on Github, do every challenge on the **main** branch and don't forget to fill in the `pull-request.txt` file. As soon as you finish your development, add the user `automator-hurb` to your repository as a contributor and make it available for at least 30 days. **Do not add the `automator-hurb` until development is complete.**
-    -   If you have any problem creating the private repository, at the end of the challenge fill in the file called `pull-request.txt`, compress the project folder - including the `.git` folder - and send it to us by email.
--   The code needs to run on macOS or Ubuntu (preferably as a Docker container)
--   To run your code, all you need to do is run the following commands:
-    -   git clone \$your-fork
-    -   cd \$your-fork
-    -   command to install dependencies
-    -   command to run the application
--   The API can be written with or without the help of _frameworks_
-    -   If you choose to use a _framework_ that results in _boilerplate code_, mark in the README which piece of code was written by you. The more code you make, the more content we will have to rate.
--   The API needs to support a volume of 1000 requests per second in a stress test.
--   The API needs to include real and current quotes through integration with public currency quote APIs
+## Executando o projeto
 
-## Evaluation criteria
+Para execução do projeto basta executarmos o comando:
+```shell
+docker compose up
+```
 
--   **Organization of code**: Separation of modules, view and model, back-end and front-end
--   **Clarity**: Does the README explain briefly what the problem is and how can I run the application?
--   **Assertiveness**: Is the application doing what is expected? If something is missing, does the README explain why?
--   **Code readability** (including comments)
--   **Security**: Are there any clear vulnerabilities?
--   **Test coverage** (We don't expect full coverage)
--   **History of commits** (structure and quality)
--   **UX**: Is the interface user-friendly and self-explanatory? Is the API intuitive?
--   **Technical choices**: Is the choice of libraries, database, architecture, etc. the best choice for the application?
+A ordem de execução será a seguinte:
+1. redis
+2. mysql
+3. worker
+4. app (com delay de 10 segundos, para que dê tempo do worker realizar as atualizações)
 
-## Doubts
+Para encerramento dos serviços:
+```shell
+docker compose down
+```
 
-Any questions you may have, check the [_issues_](https://github.com/HurbCom/challenge-bravo/issues) to see if someone hasn't already and if you can't find your answer, open one yourself. new issue!
+Se precisar alterar o fonte, envs, ou algum outro arquivo, para rebuildar os serviços, basta executar o comando abaixo:
+```shell
+docker compose up --build
+```
 
-Godspeed! ;)
+## API
 
-<p align="center">
-  <img src="ca.jpg" alt="Challange accepted" />
-</p>
+> [!IMPORTANT]
+> É necessário que os containers estejam em execução a partir deste momento
+
+O projeto estará executando na porta padrão 3000.
+
+O endereço padrão para testes:
+```
+http://localhost:3000/
+```
+
+### Documentação 
+A documentação da API foi escrita utilizando a [OpenAPI 3.0 Specification](https://swagger.io/docs/specification/about/) e se encontra no endereço:
+```
+http://localhost:3000/api-docs/
+```
+ou 
+
+[resume-doc.md](resume-doc.md)
+
+### Observações
+
+Para formatação monetária é utilizado o padrão brasileiro.
+
+Para moedas correntes foi utilzado o padrão de duas casas decimais, exemplo:
+
+```json
+{
+  "BRL": "R$ 1,00",
+  "USD": "US$ 0,20"
+}
+```
+
+para criptomoedas, utilizamos dez casas decimais:
+
+```json
+{
+  "BRL": "R$ 1,0000000000",
+  "BTC": "BTC 0,0000033427"
+}
+```