/4devs

O 4DEVS é um gerenciador de devs fácil e simples de usar | Let's spread love 👨‍💻 💜.

Primary LanguageTypeScriptMIT LicenseMIT

4DEVS

4DEVS - Gerencie todos os seus DEVS em um só lugar 👨‍💻 💜


GitHub language count Repository size Made by marcelogaldino GitHub last commit License Stargazers

Sobre   |    Tecnologias   |    Como usar   |    Como contribuir   |    License

Sobre o 4DEVS

O 4DEVS é um gerenciador de devs fácil e simples de usar | Let's spread love 👨‍💻 💜.

🚀 Tecnologias

Este projeto foi desenvolvido com as seguintes tecnologias:

NodeJS 💻
Typescript 📘
Postgres 🎲
Jest 🃏
Docker 🐳
ReactJS 💙
Styled Components 💅

Como usar ? 🤔

É necessário que você tenha algumas ferramentas instaladas antes de clonar este projeto.

  • Git
  • VSCode ou algum outro editor de sua prferência
  • Node.js (recomendado a versão LTS do site oficial)
  • NPM ou Yarn como gerenciador de pacotes. Ao instalar o NodeJS o NPM é instalado automaticamente.
  • Docker Recomendado, mas não necessário. Este projeto possui suporte ao Docker o que facilita a configuração do nosso backend, por isso recomendamos 🐳

Vamos começar!! ✍

Abra o terminal como administrador e clone o repositório:

# Clone o repositório
$ git clone https://github.com/marcelogaldino/4devs.git

Rodando o frontend da aplicação

# Vá para o diretório 4devs/
$ cd 4devs
# Vá para o diretório frontend/
$ cd frontend
# Instale as dependências
$ yarn
# Inicie a aplicação
$ yarn start

Neste momento você deverá ter o seu browser aberto automaticamente rodando a aplicação na porta 3000 http://localhost:3000

Rodando o backend da aplicação

É necessário abrir uma nova aba ou um novo terminal para este procedimento

# Volte um diretório, caso vc esteja em /cepMais/frontend
$ cd ..
# Vá para o diretório backend/
$ cd backend
# Instale as dependências
$ yarn
# Executando os testes unitários da nossa aplicação
$ yarn jest
# Subindo os containers docker da nossa aplicação
$ docker-compose up -d
# Verificando os nossos containers que estão rodando
$ docker ps #deve listar 2 containers, o 4devs e postgres
# Rodando as migrations
$ yarn typeorm migration:run
# Checando se nossa aplicação esta rodando corretamente 
$ docker logs 4devs -f

# Caso tenha algum erro ao subir os containers docker use o comando abaixo para recria-los
$ docker-compose up --build --force-recreate

Neste momento temos a nossa aplicação com o backend e seus serviços em execução, com o backend rodando na porta 3333. http://localhost:3333

Como contribuir

  • Faça um fork;
  • Crie uma nova branch com a sua feature: git checkout -b my-feature;
  • Commit as suas alterações: git commit -m 'feat: My new feature';
  • Empurre para o repositório remoto a sua nova branch: git push origin my-feature.

Abra um pull request para analisarmos as mudanças.

Você também pode nos ajudar abrindo issues.

📝 License

This project is under the MIT license. See the LICENSE for details.

Made with ♥ by Marcelo Galdino 👋 Get in touch!