Loading repository data…
andersondev96 / repository
start-business-api
Trabalho desenvolvido para o projeto final do curso de Sistemas de Informação
#javascript#nodejs#typescript
Live repository statistics
★ 1Stars
⑂ 0Forks
◯ 0Open issues
◉ 1Watchers
54/100
OPENREPOHUB HEALTH SIGNAL
Mixed signals
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
52
Community adoption25% weight
0
Maintenance state20% weight
100
License clarity10% weight
100
Project information10% weight
59
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
Trabalho de Conclusão de Curso (TCC)
Projeto desenvolvido como parte do Trabalho de Conclusão de Curso (TCC) do curso de Sistemas de Informação - UFOP.
📌 Índice
- 📄 Sobre o Projeto
- 🚀 Tecnologias Utilizadas
- 🔧 Requisitos do software
- 📂 Banco de Dados
- ⚙ Como Executar a Aplicação
- 🌍 Deploy da Aplicação
- 🤝 Como Contribuir
- 📝 Licença
- 👥 Autor
📄 Sobre o Projeto
O projeto tem como objetivo auxiliar microempreendedores individuais (MEIs) por meio de um sistema que permite a divulgação de seus negócios e serviços, aproximando-os do público-alvo e ampliando seu alcance.
⚠️ Status do Projeto:
Em manutenção - Alguns recursos podem não estar funcionando corretamente.
🚀 Tecnologias Utilizadas
O servidor foi desenvolvido em TypeScript, utilizando Node.js, PostgreSQL, Redis e diversas bibliotecas para garantir eficiência e segurança.
🔧 Requisitos do software
Usuários
- Autenticação
- Cadastro e edição de usuários
- Recuperação de senha
- Exclusão de conta
MEIs
- Cadastro e edição
- Listagem e avaliação
- Adição de imagens
- Favoritar MEIs
Serviços
- Gerenciamento completo de serviços (criar, editar, listar, excluir, avaliar, favoritar)
- Filtro de serviços
- Upload de serviços via arquivo
.xlsx
Orçamentos
- Solicitação e gerenciamento de orçamentos
- Edição e envio de orçamentos
- Aceitação ou recusa de propostas
Chat
- Acesso e envio de mensagens para empreendedores
Configurações
- Atualização de preferências
- Remoção de conta
📂 Banco de Dados
O banco de dados utilizado é o PostgreSQL. Abaixo está o diagrama ER:
⚙ Como Executar a Aplicação
Pré-requisitos
Antes de iniciar, certifique-se de ter:
- Node.js (versão LTS recomendada)
- NPM ou PNPM
- Docker
Passos para Execução
- Clone o repositório:
git clone https://github.com/andersondev96/start-business-api - Acesse a pasta do projeto:
cd start-business-api - Instale as dependências:
npm install # ou pnpm install - Configure as variáveis de ambiente no arquivo
.env - Execute as migrations do Prisma:
npx prisma migrate dev - Inicie a aplicação:
npm run dev # ou pnpm run dev - A API estará disponível em: http://localhost:3333.
As collections para testes estão disponíveis no arquivo insomnia-All_2023-10-15.json.
🧪 Testes
Para rodar os testes automatizados:
npm run test
Tecnologias utilizadas para os testes: Vitest.
🌍 Deploy da Aplicação
O deploy foi realizado na AWS EC2 com as seguintes configurações:
- Servidor: Ubuntu
- Proxy Reverso: Nginx
- Gerenciamento de processos: PM2
- Certificado de segurança SSL: Certbot
- Armazenamento de Dados: PostgreSQL & Redis
Para acessar a API utilize o endereço https://api-start-business.andersondev.tech/.
Você poderá realizar requisições HTTP, utilizando softwares como o Insomnia ou Postman.
🤝 Como Contribuir
- Fork este repositório
- Crie uma branch para sua funcionalidade:
git checkout -b minha-feature - Realize suas alterações e comite:
git commit -m "feature: Minha nova funcionalidade" - Envie para o repositório remoto:
git push origin minha-feature - Abra um Pull Request!
📝 Licença
Este projeto está sob a licença LICENSE.
👥 Autor
Anderson Fernandes Ferreira
Feito com 💚 por Anderson Fernandes 👋 Entre em conanto