/linkedin-backend

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

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!


📁 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 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!


Stack utilizada ⚙

Linguagens: TypeScript

Frameworks: node js Nestjs

Ferramentas: Run in Insomnia Visual Studio docker


Devs 👨‍💻👨‍💻


Bruno

Wanderson Santos

Mentores 🙎🏻‍♂️🙎🏻


Joana D'arc

Leonardo Monteiro

Odilon Lima

Ex contribuidores 🙎🏻‍♂️


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.