1
resposta

[Dúvida] Como orientar a execução do projeto no README?

Atualizando o README, criei o tópico 'como executar o projeto'. Para isso, segui os passos que fizemos no vídeo 6 (Json-server) da aula 1 (Simulando uma API) e ficou da seguinte forma:

  1. Faça o download do repositório através do arquivo zip ou do terminal usando o git clone;
  2. Acesse o diretório do projeto pelo seu terminal;
  3. Rode o comando npm init para inicializar o npm dentro do projeto. É necessário ter o Noje.js instalado para executar este projeto.
  4. Rode o comando npm install -g json-server para instalar as dependências.
  5. Rode o comando json-server --watch db.json para iniciar o servidor
  6. Abra o arquivo index.html em seu navegador.

Assim está correto? Alguma sugestão ou indicação de conteúdo para aprofundar sobre esse assunto?

1 resposta

Oii, Dev! Tudo bem?

Agradeço por aguardar o nosso retorno.

Parabéns por atualizar o README do seu projeto e incluir as instruções para executá-lo. Seguindo os passos que você descreveu, está correto!

Uma sugestão para aprofundar nesse assunto é aprender mais sobre gerenciadores de pacotes, como o npm, e como eles ajudam no desenvolvimento de projetos em JavaScript. Além disso, pode ser interessante pesquisar sobre como documentar projetos e incluir informações úteis para outros desenvolvedores que possam contribuir com o seu código.

Por isso, deixo abaixo, dois artigos que podem contribuir para o seu conhecimento nesses dois pontos que mencionei:

Espero ter ajudado! Qualquer dúvida, estarei à disposição para te ajudar.

Bons estudos!

Caso este post tenha lhe ajudado, por favor, marcar como solucionado ✓. Bons Estudos!