Bem vindos ao repositório Trybesmith
👨💻 O que foi desenvolvido
Aqui você vai encontrar os detalhes de como foi estruturado este projeto e instruções para rodar.
Neste projeto, foi desenvolvido uma loja de itens medievais, no formato de uma API, utilizando Typescript.
Também foi desenvolvido todas as camadas da aplicação seguindo a arquitetura MSC, (Models, Service e Controllers).
Por meio dessa aplicação, é possível realizar as operações básicas que se pode fazer em um determinado banco de dados: Criação, Leitura, Atualização e Exclusão ou CRUD.
Você irá criar alguns endpoints que irão ler e escrever em um banco de dados, utilizando o MySQL.
Orientações
🐋 Rodando no Docker vs Localmente
👉 Com Docker
Rode os serviços
nodeedbcom o comandodocker-compose up -d.
- Lembre-se de parar o
mysqlse estiver usando localmente na porta padrão (3306), ou adapte, caso queira fazer uso da aplicação em containers - Esses serviços irão inicializar um container chamado
trybesmithe outro chamadotrybesmith_db. - A partir daqui você pode rodar o container
trybesmithvia CLI ou abri-lo no VS Code.
Use o comando
docker exec -it trybesmith bash.
- Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.
Instale as dependências [Caso existam] com
npm install
👉 Sem Docker
ℹ️ Instale as dependências [Caso existam] com
npm install
- ✨ Dica: Para rodar o projeto desta forma, obrigatoriamente você deve ter o
nodeinstalado em seu computador.
Como ter acesso ao projeto e instalar as dependências
1. Entre na pasta do repositório que você acabou de clonar ou fazer o download do arquivo zip:
* `cd pasta-do-repositório`
2. Instale as dependências:
*`npm install`
3. Suba os imagens do servidor node e do banco de do docker-compose com o comando:
*`docker-compose up -d`
🎲 Entidades do projeto
- USER
- ORDER
- PRODUCT