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

[TAREFA]: Documentar como executar o projeto #39

Open
4 tasks
mateusrovedaa opened this issue Oct 18, 2024 · 1 comment
Open
4 tasks

[TAREFA]: Documentar como executar o projeto #39

mateusrovedaa opened this issue Oct 18, 2024 · 1 comment

Comments

@mateusrovedaa
Copy link
Collaborator

Descrição

Criar uma seção no README sobre como instalar os pacotes e executar o projeto.
A seção deve conter:

npm install
npm run dev

Com isso, as dependências serão instaladas e o projeto poderá ser iniciado para desenvolvimento.

Passos

  • Criar link no menu;
  • Criar seção;
  • Documentar comandos.

Validação

  • Seção como executar documentada.
@mblithium
Copy link
Collaborator

Já foi dito em uma chamada sobre, acredito que seria interessante mencionar aqui.

Na primeira tentativa deste projeto estávamos documentando uma Wiki com um projeto React que já integrava o Storybook e utilizava Yarn. Talvez seja útil no futuro, caso queiram reutilizar alguma coisa wiki do projeto lista de compras.

Claro, precisa alterar de acordo com o andamento do projeto atual.

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

2 participants