Skip to content

Latest commit

 

History

History
295 lines (163 loc) · 13.6 KB

README.md

File metadata and controls

295 lines (163 loc) · 13.6 KB

Badge em Desenvolvimento

Typing SVG

Visitantes:


Menu


Como instalar o Git Bash

O Git Bash faz parte do pacote Git for Windows, que é oferecido no próprio site oficial do Git, em: https://git-scm.com/download/win


🛠️ Abrir e rodar o projeto

  1. Instalar o Git Bash em sua máquina.
  2. Criar uma pasta do projeto em seu computador.
  3. Clique com o botão direito do mouse na pasta e selecione o Git bash.
  4. Após abrir a janela, vamos dar início no clone do projeto.

❗ Atenção, esse procedimento deve ser feito somente após o git Bash estar instalado em sua máquina!

Clone o projeto na janela que abriu com o seguinte comando:

  git clone https://github.com/SouJunior/linkedin-backend.git

Após isso pode fechar a janela!


🐳 Instalando o Docker

1.Install Docker Desktop on Mac: https://docs.docker.com/desktop/install/mac-install/

2.Install Docker Desktop on Windows: https://docs.docker.com/desktop/install/windows-install/

3.Install Docker Desktop on Linux: https://docs.docker.com/desktop/install/linux-install/

Agora você pode instalar tudo o que precisa para executar o Windows Subsystem for Linux (WSL) inserindo este comando em um PowerShell administrador ou Windows Command Prompt e, em seguida, reiniciando sua máquina.

wsl --install

Após a instalação do Wsl, vamos até a pasta do projeto e rodar o comando

docker-compose up -d

O projeto vai estar rodando em:

localhost:3000

agora basta seguir para Instalando o Insomnia


🐳 Como instalar o PostgreSQL no Windows

1.Para começar a instalação do PostgreSQL faremos o download diretamente do site oficial, a partir desse link.

Link: https://www.postgresql.org/download/windows/

2.Feito o download, em seguida abra o instalador e verá a seguinte tela: image

Clique em “Next” e na tela seguinte escolha o local onde a instalação será feita:

3.Atenção! Se você escolher um local diferente do padrão será preciso criar uma pasta e selecioná-la, pois a instalação deve ser feita em uma pasta vazia.

image

Feito isso, basta clicar em “Next” e então na tela seguinte faremos a seleção de componentes. Recomendo deixar tudo marcado mesmo, sem problemas aqui.

image

Em seguida, iremos para a tela de seleção da pasta onde os banco de dados ficarão armazenados. É uma pasta diferente da pasta de instalação. Você pode colocar dentro da pasta de instalação, mas em outra pasta separada lá dentro, como é feito por padrão.

Após clicar em “Next”, veremos a tela de seleção de senha do superuser do banco. Lembre-se de anotar essa senha para não perder ou esquecer!

image

Após clicar em “Next”, na próxima tela você vai decidir qual porta padrão o servidor do banco vai usar. Você pode usar a porta padrão, mas pode escolher outra, desde que não entre em conflito com outras portas que estejam sendo usadas na sua máquina.

image

Após clicar em “Next”, você será perguntado sobre o Cluster do Banco. Se você não sabe exatamente o que isso significa, fique tranquilo, basta deixar no Default e clicar em “Next”.

image

Nessa tela e na próxima, teremos apenas um resumo das configurações feitas até aqui. Basta clicar em “Next” e prosseguir com a instalação.

Ao concluir a instalação, vai aparecer a opção para abrir o Stack Builder, para baixar quaisquer conteúdos adicionais. Por enquanto isso não é necessário, então eu desmarquei a opção.

image

Pronto, instalação do PostgreSQL finalizada com sucesso!

🛠️ Instalando o insomnia

Link para baixar: https://insomnia.rest/download

  1. Agora basta importar o arquivo Documentação_Sou_Junior.json que esta na raiz do projeto que você terá acesso a todos as rotas.

image

  1. Após fazer a importação, colar o link do navegador no local mostrado:

  2. Agora basta navegar entre as pastas com as rotas do nossa API

image

  1. Para editar a porta da url basta seguir os passos abaixo

image

❗ Atenção, É valido lembrar que a porta do link vai se basear no computador e na porta que o navegador está usando!


📁 Acesso ao projeto

Entre na pasta do projeto pelo Visual Studio, Abra o terminal do visual Studio e vá para o diretório do projeto com o comando:

  cd linkedin-backend

Instale as dependências

  npm i

Feito a instalação dos pacotes basta renomear o arquivo .env.example para .env e preencher com as suas informações do banco de dados, no caso estamos usando o PostgreSQL

Arquivo .env

PORT=3000 #Porta que seu projeto vai rodar na sua maquina

# JWT
SECRET_KEY= qualquerStringAqui #Uma string qualquer, chave para gerar o JWT

# TYPEORM_CONNECTION
TYPEORM_CONNECTION=postgres
TYPEORM_HOST= #Host name do seu banco (geralmente quando esta na sua maquina fica localhost)
TYPEORM_PORT=5432 #A porta geralmente é 5432, se no seu caso for outra porta basta alterar
TYPEORM_USERNAME= # Seu usuario do banco postgress
TYPEORM_PASSWORD= # Sua senha do banco postgress
TYPEORM_DATABASE= # Sua database do banco de dados.

🌐 Rodando localmente

Inicie o servidor

  npm run start:dev

🐳 Instalando o Docker

1.Install Docker Desktop on Mac: https://docs.docker.com/desktop/install/mac-install/

2.Install Docker Desktop on Windows: https://docs.docker.com/desktop/install/windows-install/

3.Install Docker Desktop on Linux: https://docs.docker.com/desktop/install/linux-install/

Agora você pode instalar tudo o que precisa para executar o Windows Subsystem for Linux (WSL) inserindo este comando em um PowerShell administrador ou Windows Command Prompt e, em seguida, reiniciando sua máquina.

wsl --install

Após a instalação do Wsl, vamos até a pasta do projeto e rodar o comando

docker-compose up -d

O projeto vai estar rodando em:

localhost:3000


Stack utilizada ⚙

Linguagens: TypeScript

Frameworks: node js Nestjs

Ferramentas: Run in Insomnia Visual Studio docker


Head 🙎🏻‍♂️


Wanderson Santos

Team lead 🙎🏻


Amanda Fontes

Devs 👨‍💻👨‍💻


Amaro Francisco

Ytallo Cesar

Pedro Igor

Mentores 🙎🏻‍♂️


Thiago Rodrigues

Ex contribuidores 🙎🏻‍♂️🙎🏻


Leonardo Monteiro

Daniel Vinhas

Joana D'arc

Audinéia Carmo

Bruno

Leonardo Reis

Idealizador do projeto 🙎🏻‍♂️


Wouerner

Feedback

Se você tiver algum feedback, por favor nos deixe saber por meio do nosso Discord. Ou fazendo uma contribuição.

Contribuição

Contribuições são sempre bem-vindas!

Usado por

Esse projeto é usado pela SouJunior.