Visitantes:

---

Menu

Como Instalar o git bash

Abrir e rodar o projeto

Acesso ao projeto

Rodando Localmente

Rodando com Docker

Instalando o Insomnia

Stack Utilizada

Equipe Back-end

---

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!

1 - Faça um fork do projeto no seu Github

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

  git clone https://github.com/seuNomeDeUsuario/motor-vagas.git

Após isso pode fechar a janela!

---

🐳 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:

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.

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.

Em seguida, iremos para a tela de seleção da pasta onde os bancos 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!

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.

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”.

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.

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 está na raiz do projeto que você terá acesso a todos as rotas.

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

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

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

❗ 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 motor-vagas

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

Caso precise das informações para preencher o .env, pergunte a alguém da equipe de backend.

Arquivo .env

# TYPEORM_CONNECTION
DATABASE_HOST= #Host name do seu banco
DATABASE_PORT=5432 #A porta geralmente é 5432, se no seu caso for outra porta basta alterar
DATABASE_USER= # Seu usuario do banco postgress
DATABASE_PASS= # Sua senha do banco postgress
DATABASE_NAME= # Sua database do banco de dados.

---

🌐 Rodando localmente

Inicie o servidor

  npm run 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 estará rodando em:

localhost:3333

---

Como utilizar

Este webscrapper está em forma de api, portanto faz sua função através de requisições. As mesmas deverão ser feitas temporariamente localmente, pois o webscrapper dentro de container docker não funciona nos sites de hospedagens back-end gratuítos que encontramos, entretanto hospedamos essa api no render para que possamos nos conectar a ele e ao banco de dados e fazer a integração para outros serviços. (como o próprio portal de vagas):

Link da api no render: https://motor-vagas.onrender.com/

Coletar vagas (POST):

 URL: http://host:port/job
 BODY:
  [
  "locations": Array de strings (aceita um único item no array),
  "keyword": String
  ]

OBS: Se for procurar por vagas brasileiras no item "locations", insira "brazil", pois é a única forma que a url do linkedin (fonte de onde pegamos as vagas) reconhece como vagas daqui.

Exemplo:

 URL: http://host:port/job
 BODY:
  [
  "locations": ["brazil"],
  "keyword": python
  ]
  return: "Jobs saved successfully"

Listar vagas (GET):

 URL: http://host:port/job

 	  return:
  [
	{
  		"id": "123",
		"title": "desenvolvedor android java jr",
		"company": "Nome da compania",
		"location": "Belo Horizonte, Minas Gerais, Brazil",
		"time": "6 hours ago",
		"link": "link para a vaga",
		"jobName": "desenvolvedor-android-java-jr-at",
		"created_date": "data de criaçao",
		"visa": false,
		"description": "",
		"source": "Linkedin"
	},
  ]

Deletar vagas (DELETE):

URL: http://host:port/job

---

( OPCIONAIS )

Coletar nomes de empresas do site relocate.me (POST):

 URL: http://host:port/company/relocateMe

Coletar nomes de empresas do site siaExplains (POST):

 URL: http://host:port/company/siaExplains

---

Stack utilizada ⚙

Linguagens:

Frameworks:

Ferramentas:

---

Head 🙎🏻‍♂️

Ricardo Machado

Devs 👨‍💻👨‍💻

Patrick Otero	Mikael Melo

Mentores 🙎🏻‍♂️

Lucas Rigon

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.