README.md

🚧 Aplicação Finalizada! 🚧

🏁 Tópicos

👉 Sobre
👉 Funcionalidades
👉 Layout
👉 Como executar
👉 Tecnologias
👉 Autor
👉 Licença

💻 Sobre o projeto

API do clone do Instagram.

---

⚙️ Funcionalidades

• Rotas de usuário:
  • Registrar;
  • Listar;
  • Detalhar (um único usuário);
  • Logar.
• Rotas de postagens:
  • Criar;
  • Listar (de acordo com os seguidores);
  • Detalhar (um único post);
  • Deletar.
• Rotas de Curtidas:
  • Atualizar (curtir ou descurtir).
• Rotas de Seguir (Follow):
  • Atualizar (seguir ou não seguir).
• Rotas de Comentários:
  • Criar;
  • Deletar.
• Rotas de Notificações:
  • Listar (de acordo com o usuário);
  • Atualizar (somente se o usuário visualizou ou não a notificação).
• Socket.io foi adicionado para:
  • Curtidas;
  • Comentários;
  • Postagens (criar e deletar);
  • Seguidores;
  • Notificações.
• Cloudinary foi utilizado para armazenar as imagens (deleta as imagens quando um post é deletado);
• Autentificação de rotas por meio de JWT;
• MongoDB foi utilizado para armazenar os dados.

---

🎨 Layout

• Frontend

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn.d Além disto é bom ter um editor para trabalhar com o código como VSCode

Váriaveis de Ambiente

Veja o arquivo .env.sample

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone https://github.com/grochavieira/instagram-clone-backend.git

# Acesse a pasta do projeto no terminal/cmd
$ cd instagram-clone-backend

# Vá para a pasta server
$ cd server

# Instale as dependências com npm
$ npm install

# Execute a aplicação
$ npm start

# O servidor inciará na porta:3333 - acesse http://localhost:3333

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (NodeJS + TypeScript)

• express
• CORS
• mongoDB
• mongoose
• cloudinary
• jsonwebtoken
• image-data-uri
• ts-node
• multer
• socket.io

Veja o arquivo package.json

Utilitários

• Editor: Visual Studio Code
• Teste de API: Insomnia

---

🦸‍♂️ Autor

_{🌟 Guilherme Rocha Vieira 🌟}

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com 😆 por Guilherme Rocha Vieira 👋🏽 Entre em contato!

---