Sistema-Clinica-Estetica-API 💅🏽

Indice 👨‍💻

1 - 🚪Introdução •

2 - 👩🏽‍🌾 Criação e Tecnologias •

3 - 👇🤘 Como instalar •

4 - 🤘Como Usar •

5 - Considerações finais •

6 -🧑‍💻 Autor •

7- Licença •

Edições ✏️📑

Alterações	Data	Versão
Emissão Inicial	08/10/22	1.0.1

1 - Introdução

Sistema Zau-estetica é um voltado para o gestão de agendamento de clientes, o nome ZAU e homenagem a minha mãe.

2- Criação e Tecnologias 👩🏽‍🌾😰

Check list de desenvolvimentos em andamento

Funcionalidade

• Rota de Usuário e Autenticação
• Rota de Tipos de Usuário
• Rota de Agendamento
• Rota de Clientes
• Rota de Funcionarios
• Rota de Ocupacoes
• Rota de Tipo de Serviços

Testando

• Rota de Usuário e Autenticação
• Rota de Tipos de Usuário
• Rota de Agendamento
• Rota de Clientes
• Rota de Funcionarios
• Rota de Ocupacoes
• Rota de Tipo de Serviços

👥 Principais Tecnologia usadas até o momento

• Typescript • PostgresSQL • Express • Sequelize • Nodejs

Novamente, como sempre como nos projetos anteriores utilizei arquitura MVC

3- Como instalar 🧑‍🔧

DATABASE

ATENCÃO🚨

MIGRATIONS

1. Tenha um NODEjs e PostgresSQL 11 instalado.

2. Clone o projeto.

3. Digite na pasta do projeto npm install.

4. Entre na pasta /database-migrations

5. Crie um .env na /database-migrations com as configuracao abaixo:

            DB_HOST=
            DB_PORT=
            DB_DATABASE=
            DB_USER=
            DB_PASSWORD=
            DB_DIALECT=
   

Preencha as configurações como o exemplo abaixo:

Exemplo preenchido .env:

            DB_HOST='localhost'
            DB_PORT=5432
            DB_DATABASE='db_zauestetica'
            DB_USER='postgres'
            DB_PASSWORD='admin'
            DB_DIALECT='postgres'

6. Digite npx sequelize-cli db:migrate dentro da pasta /database-migrations.

7. ATENÇAO🚨

Se ele der algum erro, digite o comando acima novamente.

8. Em seguida digite para criar os previlegios do usuário tabela previlegie_users no banco de dados.

   npx sequelize-cli db:seed:all

SISTEMA

7. Após isso crie um .env na pasta raiz / e configure apontando para sua base de dados. Conforme abaixo ou como sua preferencia :

Exemplo nao preenchido no arquivo .env.example:

            DB_HOST=
            DB_PORT=
            DB_DATABASE=
            DB_USER=
            DB_PASSWORD=
            DB_DIALECT=

            PORT_SERVER=
            TOKEN_SECRET=

Exemplo preenchido .env:

            DB_HOST='localhost'
            DB_PORT=5432
            DB_DATABASE='db_zauestetica'
            DB_USER='postgres'
            DB_PASSWORD='admin'
            DB_DIALECT='postgres'


            PORT_SERVER=3000
            TOKEN_SECRET='segredotoken'

8. Após volte para pasta / e digite seguinte comando abaixo:

   npm run build

9. Em seguida para roda o projeto digite npm run prod

10 . Dentro da pasta /assets há a collection da API chamada collection_api_har-date, poderá usar para Usar na API de Teste, Insomnia ou postman de sua preferencia.

4- Como usar 👩‍💻

Cada usuário usuário pode ser logar

Basicamente tem 8 Rotas principais !

1. Rota de Usuário e Autenticação = Onde o usuário faz login e ser registrar
2. Rota de Tipos de Usuário = Tipo determina quais rotas o usuário pode acessar
3. Rota de Clientes = Após cadastrar o usuário este pode ser atribuido ou um cliente ou um funcionario nunca o mesmo
4. Rota de Funcionarios = Após cadastrar o usuário este pode ser atribuido ou um cliente ou um funcionario nunca o mesmo
5. Rota de Ocupacoes = Cadastrado algumas ocupacoes dos funcionario do centro estetico
6. Rota de Agendamento = Quando um funcionario abre a sua agenda o cliente podera escolher um horario,
7. Rota de Tipo de Serviços = Após o cliente marcar um horario poderá se atribuido um servico.

O sistema de autenticacão foi feito nas rotas da api. Controle eles seus niveis de force, contido na tabela do previlegie_users do seu banco de dados

Haverá 3 Tipos de Usuário

1. Cliente : O mais fraquinho : poderá controlar somente a rota de /users/ e /clientes e seus dados
2. Funcionario : controlar a rota /operador/ poderá somente controlar as rotas de operador/ agendamento, /ocupacoes/, /tiposervicos/. Ele marca os horario controla os agendamentos, serviços prestados em muito mais.
3. Administrador : Com acesso a rota admin poderá controlar todas as rotas do sistema ele detêm o poder máximo da aplicacão "Tipo um Usuário DEUS"

5 -🥺😭 Considerações finais

Ahhh, mas você já vai ir embora 😢 ...

Esse projeto ainda esta sendo criado. adicionar as funcionalidade ao poucos, até que ele chegue ao seu padrão definitivo. no mais muito obrigado! 🤗🙋‍♂️!

Autor ✍🏻

---

_{Joao Guilherme} 🚀

Feito com 🤭 por Joao Guilherme 👋🏽 Entre em contato!

7 - Licença