Sobre • Como executar • Tecnologia • Como contibruir •
O projeto é uma plataforma com materiais de estudo , a desenvolvedores que querem aprender a construir um bom Readme. Para que estudantes e iniciantes na área consigam um material de apoio direto, através de vídeos, artigos e templates. Um Readme bem elaborado é essencial num processo seletivo, intruções de como executar o projeto.
Antes de iniciar, é necessário ter o NodeJs ou Yarn baixado na máquina.
# Clone este repositório
$ git clone https://github.com/LarisseLima/hello-readme
# Acesse a pasta do projeto no terminal/cmd
$ cd helloreadme
# Instale as dependências
$ yarn install ou npm install
# Execute a aplicação em modo de desenvolvimento
$ yarn start ou npm start
# A aplicação será aberta na porta: 3000 - acesse o endereço: http://localhost:3000
- Faça um fork do projeto.
- Clone o seu repositório forkado
git clone link do seu fork
- Crie uma nova branch para as suas alterações:
git checkout -b add-links-seu-nome
- Para adicionar seu link, vá a pasta Services e edite o arquivo api.json, seguindo a organização e estrutura do arquivo.
- Salve as alterações adicione
git add Services
e crie uma mensagem de commit contando o que você fez:git commit -m "links: mensagem"
- Envie as suas alterações:
git push origin add-links-seu-nome
Este projeto está sob a licença MIT.
Feito com :coffee:
por Larisse Lima