saraivais / medieval-store

CRUD RESTful API to simulate the management system of a medieval/fantasy store. Developed during the Back-end module at Trybe

⚔️ MEDIEVAL STORE 🛡️

English 🇬🇧

Click to expand!

Description 📝

Medieval Store is a RESTful API developed with the MSC (Model-Service-Controller) layered software architecture during the Back-end module at Trybe in September, 2022.
The objective of Medieval store is to simulate the management system of a medieval/fantasy store with CRUD endpoints for users, products and orders.

Technologies and Tools 🔧

Medieval Store was developed through Docker to create an isolated development environment. The npm package express-async-errors was used to deal with asynchronous errors. This project was developed using the MSC (Model-Service-Controller) layered architecture, with MySQL as the chosen database management system.
Also, the jsonwebtoken (JWT) library was used to generate and authenticate tokens, adding a layer of security to this API, using validation through middlewares. The Express.js framework was used to structure this API's endpoints in a RESTful manner and the TypeScript superset was used to develop a robust, strongly typed software.
Afterwards, Swagger and Postman were used to write and publish Medieval Store's documentation.

🎯 This API's documentation is available here!

Português 🇧🇷

Clique para expandir!

Descrição 📝

Medieval Store é uma API RESTful desenvolvida com a arquitetura de software em camadas MSC (Model-Service-Controller) durante o módulo Back-end na Trybe em Setembro de 2022.
O objetivo do Medieval Store é simular o sistema de gestão de uma loja medieval/fantasia com endpoints CRUD para usuários, produtos e pedidos.

Tecnologias e Ferramentas 🔧

Medieval Store foi desenvolvido através do Docker para criar um ambiente de desenvolvimento isolado. O pacote npm express-async-errors foi usado para lidar com erros assíncronos. Este projeto foi desenvolvido utilizando a arquitetura em camadas MSC (Model-Service-Controller), com o MySQL como sistema de gerenciamento de banco de dados escolhido.
Além disso, a biblioteca jsonwebtoken (JWT) foi utilizada para gerar e autenticar tokens, adicionando uma camada de segurança a esta API, utilizando validações via middlewares. A estrutura Express.js foi usada para estruturar os endpoints dessa API de maneira RESTful e o superset TypeScript foi usado para desenvolver um software robusto e fortemente tipado.
Posteriormente, Swagger e Postman foram usados ​​para escrever e publicar a documentação da Medieval Store.

🎯 A documentação desta API está disponível aqui!