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
• Banco de Dados
• Como Executar a Aplicação
• Deploy da Aplicação
• Como Contribuir
• Licença
• Autor

⚒ Projeto em Manutenção

Alguns recursos podem não estar funcionando corretamente.

---

📄 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.

---

🧑‍💻 Tecnologias Utilizadas

O servidor foi desenvolvido em TypeScript, utilizando Node.js, PostgreSQL, Redis e diversas bibliotecas para garantir eficiência e segurança.

---

🔧 Requisitos

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

Requisitos

Antes de iniciar, certifique-se de ter:

• Node.js (versão LTS)
• npm ou pnpm
• Docker

Passos para Execução

1. Clone o repositório:

   git clone https://github.com/andersondev96/start-business-api

2. Acesse a pasta do projeto:

   cd start-business-api

3. Instale as dependências:

   npm install # ou pnpm install

4. Configure as variáveis de ambiente no arquivo .env
5. Execute as migrations do Prisma:

   npx prisma migrate dev

6. Inicie a aplicação:

   npm run dev # ou pnpm run dev

7. 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.

---

⚙ Deploy da Aplicação

O deploy foi realizado na AWS EC2 utilizando:

• Ubuntu para configuração do servidor
• Proxy Reverso (Nginx)
• Gerenciador de processos (PM2) para manter a aplicação ativa

---

🤝 Como Contribuir

1. Fork este repositório
2. Crie uma branch para sua funcionalidade:

   git checkout -b minha-feature

3. Realize suas alterações e comite:

   git commit -m "feature: Minha nova funcionalidade"

4. Envie para o repositório remoto:

   git push origin minha-feature

5. 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