Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adicionar Documentação: Como Subir o Frontend e o Backend #14

Open
5 tasks
pyramidsf opened this issue Dec 13, 2024 · 0 comments
Open
5 tasks

Adicionar Documentação: Como Subir o Frontend e o Backend #14

pyramidsf opened this issue Dec 13, 2024 · 0 comments
Milestone

Comments

@pyramidsf
Copy link
Collaborator

Adicionar Documentação: Como Subir o Frontend e o Backend

Descrição

Criar uma documentação detalhada para orientar os desenvolvedores sobre o processo de inicialização do frontend e do backend do projeto. Isso ajudará a equipe a configurar o ambiente de desenvolvimento de forma rápida e eficiente.

Tarefas

  • Criar uma seção no README ou um arquivo separado (docs/setup.md).
  • Explicar os pré-requisitos necessários (como versões de ferramentas, dependências e ambiente).
  • Instruir como instalar e configurar o frontend:
    • Comandos para instalar dependências.
    • Comandos para iniciar o servidor de desenvolvimento.
  • Instruir como instalar e configurar o backend:
    • Comandos para instalar dependências.
    • Comandos para iniciar o servidor backend.
  • Adicionar exemplos de comandos e possíveis erros comuns com soluções.

Critérios de Aceitação

  • A documentação deve ser clara, objetiva e formatada adequadamente em Markdown.
  • Qualquer pessoa deve ser capaz de seguir o guia e subir o ambiente completo.
  • Incluir capturas de tela ou exemplos de saídas de comandos, se necessário.
@pyramidsf pyramidsf added this to the Sprint #3 milestone Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant