|
1 | 1 | # MEUPJ |
2 | 2 |
|
3 | | -`Análise e Desenvolvimento de Sistemas` |
| 3 | +Projeto acadêmico de um sistema para organização comercial e financeira de pequenos negócios, com backend, web e mobile no mesmo repositório. |
4 | 4 |
|
5 | | -`Desenvolvimento de uma Aplicação Distribuída` |
| 5 | +## Curso |
6 | 6 |
|
7 | | -`Etapa 4` |
8 | | - |
9 | | -O app reúne, em um só lugar, a organização comercial e financeira do negócio, ajuda o profissional a apresentar, registrar e formalizar vendas e serviços, com emissão de proposta, orçamento, pedido e ordem de serviço, além de personalização visual para transmitir mais profissionalismo (adicionar logo e editar cores). Também oferece um controle financeiro prático do caixa, permitindo acompanhar faturamento, recebimentos, valores em aberto ou atrasados, registrar custos e despesas e visualizar gráficos para comparar entradas, saídas e previsões financeiras. |
| 7 | +- Análise e Desenvolvimento de Sistemas |
| 8 | +- Desenvolvimento de uma Aplicação Distribuída |
| 9 | +- Etapa 4 |
10 | 10 |
|
11 | 11 | ## Integrantes |
12 | 12 |
|
13 | | -* Frederico Furtado Amantino Vieira |
14 | | -* Guilherme de Andrade Castro Vieira |
15 | | -* Maria Julia Gonçalves Maia Sales |
16 | | -* Eric Esteves Martins |
17 | | -* Amanda Vitor Lopes |
18 | | -* Bruna Bricio Alvarenga Sampaio |
| 13 | +- Frederico Furtado Amantino Vieira |
| 14 | +- Guilherme de Andrade Castro Vieira |
| 15 | +- Maria Julia Gonçalves Maia Sales |
| 16 | +- Eric Esteves Martins |
| 17 | +- Amanda Vitor Lopes |
| 18 | +- Bruna Bricio Alvarenga Sampaio |
19 | 19 |
|
20 | 20 | ## Orientador |
21 | 21 |
|
22 | | -* Carolina Stephanie Jerônimo de Almeida |
| 22 | +- Carolina Stephanie Jerônimo de Almeida |
| 23 | + |
| 24 | +## Estado Atual do Projeto |
| 25 | + |
| 26 | +O código ativo do sistema está centralizado em [`src/`](src/README.md), que hoje reúne: |
| 27 | + |
| 28 | +- API em Fastify com MongoDB, Better Auth e geração de documentos PDF |
| 29 | +- aplicação web em Next.js |
| 30 | +- aplicação mobile em Expo, com suporte web para desenvolvimento |
23 | 31 |
|
24 | | -## Instruções de utilização |
| 32 | +As funcionalidades implementadas e verificáveis atualmente estão descritas no README técnico de [`src/`](src/README.md). Esse é o ponto de entrada canônico para entender a solução em funcionamento. |
25 | 33 |
|
26 | | -Assim que a primeira versão do sistema estiver disponível, deverá complementar com as instruções de utilização. Descreva como instalar eventuais dependências e como executar a aplicação. |
| 34 | +## Como Rodar |
27 | 35 |
|
28 | | -# Documentação |
| 36 | +Os comandos do sistema devem ser executados a partir de [`src/`](src/README.md): |
29 | 37 |
|
30 | | -<ol> |
31 | | -<li><a href="docs/01-Documentação de Contexto.md"> Documentação de Contexto</a></li> |
32 | | -<li><a href="docs/02-Especificação do Projeto.md"> Especificação do Projeto</a></li> |
33 | | -<li><a href="docs/03-Metodologia.md"> Metodologia</a></li> |
34 | | -<li><a href="docs/04-Projeto de Interface.md"> Projeto de Interface</a></li> |
35 | | -<li><a href="docs/05-Arquitetura da Solução.md"> Arquitetura da Solução</a></li> |
36 | | -<li><a href="docs/06-Template Padrão da Aplicação.md"> Template Padrão da Aplicação</a></li> |
37 | | -<li><a href="docs/07-Programação de Funcionalidades.md"> Programação de Funcionalidades</a></li> |
38 | | -<li><a href="docs/08-Registro de Testes Unitários.md"> Registro de Testes Unitários</a></li> |
39 | | -<li><a href="docs/09-Registro de Testes de Integração.md"> Registro de Testes de Integração</a></li> |
40 | | -<li><a href="docs/10-Registro de Testes de Sistema.md"> Registro de Testes de Sistema</a></li> |
41 | | -<li><a href="docs/11-Registro de Contribuição.md"> Registro de Contribuição</a></li> |
42 | | -<li><a href="docs/12-Apresentação do Projeto.md"> Apresentação do Projeto</a></li> |
43 | | -<li><a href="docs/13-Referências.md"> Referências</a></li> |
44 | | -</ol> |
| 38 | +```bash |
| 39 | +cd src |
| 40 | +pnpm install |
| 41 | +pnpm dev |
| 42 | +``` |
45 | 43 |
|
46 | | -# Código |
| 44 | +Comandos principais do monorepo: |
47 | 45 |
|
48 | | -<li><a href="src/README.md"> Código Fonte</a></li> |
| 46 | +```bash |
| 47 | +cd src |
| 48 | +pnpm build |
| 49 | +pnpm lint |
| 50 | +pnpm test |
| 51 | +``` |
49 | 52 |
|
50 | 53 | # Deploy |
51 | 54 |
|
52 | 55 | <li><a href="https://meupj-api-student.delightfulwave-8b9abc5f.brazilsouth.azurecontainerapps.io/">meupj.azurecontainerapps.io</a></li> |
53 | 56 |
|
54 | 57 | # Apresentação |
55 | 58 |
|
56 | | -<li><a href="presentation/README.md"> Apresentação da solução</a></li> |
| 59 | +- [`src/README.md`](src/README.md): documentação técnica canônica do código atual |
| 60 | +- [`docs/`](docs): artefatos acadêmicos organizados por etapa |
| 61 | +- [`presentation/README.md`](presentation/README.md): orientação sobre os materiais de apresentação |
| 62 | +- [`videos/README.md`](videos/README.md): orientação sobre os registros em vídeo |
0 commit comments