/dragsters-backend

Primary LanguageTypeScript

Sobre

Tecnologias utilizadas

  • Node.js
  • TypeScript
  • TypeORM
  • Postgres
  • Celebrate
  • JWT

Front-end

Visite o repositório do front-end construído em React.js.

Protótipos (Mockups)

Visite o projeto no Figma para conferir o protótipo.

Como contribuir 😃

Para contribuir com este projeto é necessário realizar um Fork, esta ação permite criar uma cópia virtual do repositório original de um projeto para a sua conta Github.

Realizar o Fork

  • Basta clicar na opção Fork acima.

Depois de realizar o Fork siga estes passos:

  • Navegue até os seus repositórios. Você deverá encontrar dragsters-backend na lista.
  • Clone o projeto para a sua máquina a partir do fork criado na sua conta Github.
  • Navegue até a raiz do projeto e crie uma branch com o seu nome ou apelido.
  • Sinta-se livre para codar.
  • Lembre-se de sempre manter o fork atualizado.

Mantendo o Fork atualizado ✔️

Adicione o repositório original como referência de servidor remoto. Chame-a de upstream.

O comando ficará assim:

# O upstream deve estar mapeado para o repositório original
git remote add upstream https://github.com/Tava1/dragsters-backend.git

Depois execute o seguinte comando:

git fetch upstream

Neste repositório utilizamos a branch master como a branch padrão (Não utilize está branch para enviar suas alterações).

Sempre que houver alterações no repositório original realize um pull desta forma.

git pull upstream master

Assim você mantem o repositório que está trabalhando sempre atualizado.

Ultimos passos para começar o desenvolvimento 🏁

Navegue até a raiz do projeto e execute o seguinte comando no terminal:

# Este comando irá instalar todas as dependências necessárias do projeto. 
yarn

Após a instalação das depências, podemos utilizar alguns comando disponíveis.

🚧 Ambiente de desenvolvimento

Iniciar um ambiente de desenvolvimento local.

yarn dev:server

🔧 Build do projeto

Realizar o build do projeto.

yarn build

Enviar alterações 🆙

  • Certifique-se de estar trabalhando na sua branch.
  • Não envie alterações para a branch master, caso ocorra serão descartadas.

Caso ainda não possua uma branch, utilize este comando para criar:

git checkout -b <seu-nome-ou-apelido>
  • Realize o commit de suas alterações

Realize o push com o seguinte comando:

git push origin nome-da-sua-branch


# Caso ainda não possua o origin mapeado para o seu fork basta executar:
git remote add origin <url-fork>

Criando um Pull Request

Após o push acesse o Github e vá até o fork, você irá se deparar com um aviso possuindo duas opções: Pull Request e Compare. Clique na opção Pull Request.

Depois basta se certificar que está tudo certo e ir clicando na opção Create Pull Request.

Pronto, logo irei analisar.