MegaHack_backend

Este é o backend da plataforma Origin, marketplace de venda de produtos alimentícios para pequenos estabelecimentos. O repositório do front-end se encontra em https://github.com/KZTN/MegaHack_frontend (acesse para mais detalhes)

Começando...

Essas instruções fornecerão uma cópia do projeto em execução na sua máquina local para fins de desenvolvimento e teste.

Pré-requisitos

O que você precisa para instalar o software:

node v12.x
yarn 1.22.4
git

Para uma melhor experiência no ambiente de testes com o servidor API REST, recomenda-se o uso do insomnia

Instalando o projeto 🚀

Clonando o projeto:

git clone https://github.com/KZTN/MegaHack_backend.git

Navegando até a pasta do projeto:

cd MegaHack_backend

Baixando as dependências do projeto:

yarn install

Rodando o projeto:

yarn start

Visite http://localhost:3333 com o seu navegador para ver o resultado. 🎉

📄 Documentação

• Versão unificada

🧪 Tenologias utilizadas:

• NodeJS - Plataforma da aplicação
• Javascript - Linguagem de programação
• multer-s3 - Recurso de envio de imagens para a CDN da AWS S3
• Mongoose - ORM de Banco de dados do mongodb utilizado na aplicação
• Express - Endpoint de chamadas e requisições HTTP
• Yup - Validator de compor de requisições a API

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Como contribuir

• Faça um fork desse repositório;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.