YourClients

Projeto • Objetivo • Funcionalidades • Layout • Como executar • Autora

💻 Projeto

No app YourCustomers você pode obter uma lista de todos os seus clientes, adicionar, editar, remover e listar! ✨

---

⚙️ Funcionalidades

• CRUD para clientes:

  • GET
  • POST
  • PUT
  • DELETE

• Utilizando Typescript

• Utilizando material-ui

---

🎨 Layout

🚀 Como executar o projeto

Este projeto está dividido em duas partes:

1. Backend 🎲
2. Frontend (este repositório)

💡 O front-end não precisa que o back-end esteja rodando para funcionamento da aplicação.

Para ver as funcionalidades basta acessar o último deploy ou clicar no link da página.

Pré-requisitos

Para rodar a aplicação na sua máquina, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e MongoDB. Além disto é bom ter um editor para trabalhar com o código como VSCode.

Rodando a aplicação web (Front-end) 🧭

# Clone este repositório
$ git clone git@github.com:yaratavares/YourCustomers.git
# Acesse a pasta do projeto no terminal/cmd e instale as dependências
$ npm install
# Será necessário criar uma pasta .env como segue o modelo do arquivo .env.example
# Execute a aplicação em modo de desenvolvimento
$ npm run start
# O servidor iniciará na porta:3000 - acesse http://localhost:3000

---

🛠 Tecnologias

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

Front-end

Veja o arquivo package.json

Back-end

Veja o arquivo package.json

---

🧜‍♀️ Autora

Yara Tavares 🚀