Visitantes:

---

Menu

Rodando localmente

Documentação

Stack Utilizada

Equipe Back-end

Pré-requisitos:

• git
• docker
• insomnia

---

🛠️ Rodando localmente

Clone o projeto ou o fork do projeto com o seguinte comando:

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

Em seguida, instale as dependências:

npm install

Suba os containers docker na sua máquina via docker compose:

docker compose up -d

Crie o arquivo .env seguindo o exemplo contido em .env.example.

Aplique as migrations do TypeORM no seu banco de dados local:

npm run migration:run

Por fim, inicie o servidor:

npm run dev # ou npm run start:dev

---

📜 Documentação

Quando você iniciar o seu servidor local, a documentação Swagger vai estar rodando em

http://localhost:{PORT}/api

Se você quiser testar as rotas no Insomnia ou Postman, importe o arquivo Documentação_Sou_Junior.json e as rotas serão configuradas automaticamente.

---

Stack utilizada ⚙

Linguagens:

Frameworks:

Ferramentas:

DevOps

Warning

Vagas Web App utiliza API disponível em https://motor-vagas.onrender.com/docs/ O que, pela URL, indica possibilidade do repo "vagas-api" não estar sendo utilizado

Tip

Caso não esteja sendo utilizado, atualizar README apontando para o novo repositório e arquivar repositório vagas-api

Caution

Pull Requests para main atualizam a imagem docker de produção

Tip

Atualizar "Deploy to Production", removendo "on: pull_request: branches: [main]"

Important

Repositório possui github workflow para deploy de homologação, mas commit mais recente foi um PR direto para main

Warning

AWS ECR e Railway configurados para o mesmo repo

sequenceDiagram
    actor Dev as Desenvolvedores
    participant Git as GitHub
    participant Rail as Railway
    participant Actions as GitHub Actions
    participant ECR as AWS ECR

    Note over Dev,ECR: Fluxo de Deploy com Preview

    Dev->>Git: Abre Pull Request (PR) para main
    Git->>Actions: Novo Evento: PR criada
    Actions->>Actions: Cria imagem Docker
    Actions->>ECR: Atualiza imagem Docker "$REGISTRY/vagas:latest"
    ECR->>Actions: Imagem "$REGISTRY/vagas:latest" atualizada
    Actions-->>Git: Deploy de Produção atualizado

    Note over Dev,ECR: Loop de desenvolvimento
    
    Dev->>Git: Aprova e mergeia PR para main
    par
        Git->>Rail: Novo Evento: Branch main atualizada
        Rail-->>Git: Deploy de Produção "*.up.railway.app" atualizado
    and
        Git->>Actions: Novo Evento: Branch main atualizada
        Actions->>Actions: Cria imagem Docker
        Actions->>ECR: Atualiza imagem Docker "$REGISTRY/vagas:latest"
        ECR-->>Actions: Imagem "$REGISTRY/vagas:latest" atualizada
        Actions-->>Git: Deploy de Produção atualizado
    end

Loading

---

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 fazendo uma contribuição.

Contribuição

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

Usado por

Esse projeto é usado pela SouJunior.

---

Voltar ao 🔝