pennaor/trybe-smith

TrybeSmith Project

Projeto de uma API de loja de itens medievais elaborado ao longo do curso de desenvolvimento Web da Trybe

A API teve como objetivo consolidar os aprendizados sobre classes, sendo estruturada sob os princípios REST e arquitetura MSC (Model, Service, Controller).

⚠️ MySQL deve estar instalado para o funcionamento da API!

Quick start

1. Clone e mude para a pasta do repositório:

git clone git@github.com:pennaor/trybe-smith.git
cd trybe-smith
npm install

2. Crie um arquivo .env com as variáveis da ambiente exemplificadas no arquivo .env.example presente na raíz do projeto.

3. Execute as queries do arquivo Trybesmith.sql no cliente MySQL para criar o banco de dados

4. Inicie a aplicação com npm start.

Features

• Cadastro, login e autenticação de usuários

• Buscar e cadastrar pedidos e produtos

Tools

• NodeJS
• TypeScript
• ExpressJS
• JSON Web Token
• Joi
• Eslint

Trybe

• São de total autoria da Trybe:
  • O arquivo Trybesmith.sql, que é responsável pela criação do banco de dados usado pela API
• Regras de ESLint