gabrielfray / customer-registration-with-contact-link

Customer registration with contact link (Aplicação Web)

Tabela de Conteúdos

1. Sobre
2. Links Relevantes
3. Techs
4. Instalação
5. Desenvolvido por
6. Termos de uso

---

1. Sobre

• A finalidade desta API é criar um sistema de cadastro simplificado de clientes, onde será possível vincular contatos a cada cliente. A Api permitirá a visualização dos clientes e dos contatos vinculados a eles de forma organizada e fácil de acessar. Além disso, essa Api fornecerá as funcionalidades básicas de um CRUD (criação, leitura, atualização e exclusão) para gerenciar esses dados de forma eficiente e segura, permitindo que você mantenha seu cadastro de clientes atualizado e sempre à mão. Em resumo, a Api de cadastro de clientes com vínculo de contatos oferece uma solução simplificada e prática para gerenciar seus dados de clientes e contatos.

2. Links relevantes

• Link da aplicação front-end
• Link da aplicação back-end

3. Techs

Visão Geral das tecnologias usadas no projeto.

• React
• Vite
• TypeScript
• Material Icon MUI
• yup
• axios
• react-router-dom
• animate.css
• react-toastfy
• styled-components
• react-hook-form
• react-icons

4. Instalação e uso

4.1 Requisitos:

• React a partir da versão 18.0
• Gerenciador de pacotes yarn ou npm
• Rodar a aplicação Back-end localmente

4.2 Instalação

4.2.1 - Para executar a aplicação localmente, siga os passos descritos na documentação da Api, disponível em GitHub. Se desejar utilizar o deploy, utilize o link https://customer-registration-api.onrender.com e insira-o na variável baseUrl na pasta services. No entanto, é importante ressaltar que a versão em deploy pode apresentar problemas de lentidão, sendo recomendado o uso da aplicação rodada localmente.

4.2.2 - Após o clone no repositório para adicionar todas as dependências do package json execute o comando: yarn install

4.2.2 - Para rodar projeto utilize o comando yarn dev no terminal, caso de tudo certo receberá uma mensagem parecida com essa:

[INFO] 17:23:18 ts-node-dev ver. 2.0.0 (using ts-node ver. 10.9.1, typescript ver. 4.8.4)
VITE v4.0.4  ready in 4915 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose  
  ➜  press h to show help

4.2.3 - O deploy do seu projeto foi realizado no Vercel e pode ser acessado pelo link Get in touch. No entanto, é necessário rodar o back-end localmente para garantir que todas as requisições funcionem corretamente.

5. Desenvolvido por

Voltar para o topo

• Gabriel Fray

6. Termos de uso

Este é um projeto Open Source para fins educacionais e não comerciais, Tipo de licença - MIT