mathcale / counter-and-user-api

APIs serverless para contagem de acessos a um site e cadastro simples de usuários

Counter & User API

Stacks serverless para contagem de acessos ao site e cadastro de usuários

Arquitetura

As definições de endpoints, modelos de dados e diagramas de fluxo podem ser encontrados no arquivo ARCHITECTURE.md.

Tecnologias

• NodeJS v14, via nvm
• Yarn v1
• AWS
  • API Gateway
  • Lambda
  • DynamoDB
  • CloudFormation (SAM template)
  • SAM CLI
• Docker e docker-compose

Rodando localmente

Obs: É suposto que você tenha o Node, SAM CLI, Docker e docker-compose instalados em seu computador. Caso contrário, use os links acima para obtê-los.

1. Clone o repositório em sua máquina;
2. Na raiz do projeto, execute yarn build para resolver as dependências dos subpacotes com o Lerna;
3. Execute o comando ./scripts/create-local-database.sh para criar a estrutura do banco de dados com o DynamoDB-Local;
4. Inicie a API desejada com ./scripts/run-local.sh <nome-da-api>, substituindo <nome-da-api> por counter-api ou user-api;
5. Utilize um cliente de testes de requisição HTTP para interagir com a API. Foi utilizado o Insomnia durante o desenvolvimento do projeto, e o arquivo contendo a collection de teste dos endpoints pode ser encontrado em docs/collections/insomnia-requests-collection.json.