Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joaog23/sistema-acesso-api

API de um Sistema de Segurança e Controle de acesso de pessoas, cujo o intuito, controlar e gerenciar com fluxo de usuários sistema.👌🏽👩🏽‍💼
https://github.com/joaog23/sistema-acesso-api

access-control api-rest nodejs postgresql security

Last synced: about 1 month ago
JSON representation

API de um Sistema de Segurança e Controle de acesso de pessoas, cujo o intuito, controlar e gerenciar com fluxo de usuários sistema.👌🏽👩🏽‍💼

Awesome Lists containing this project

README 

        





API Sistema-Acessos 🧬






### Indice 👨‍💻









 


  •  1 - 🚪Introdução •
    • 

     
  •  2 - ⚙️ Desenvolvimento • 
    • 

     
  •  3 - 👇🤘 Como instalar • 
    • 

     
  •  4 - 🤘Como Usar • 
    • 

     
  •  5 - Considerações finais  • 
    • 

     
  •  6 -📁😅🤪 Coisa não tão relevantes • 
    • 

     
  •  7 -🧑‍💻 Autor • 
    • 

     
  •   8- Licença • 
    • 


    ## Edições ✏️📑
    


    Alterações   | Data | Versão

    :---------: | :------: | :------:

    Dismebramento entre API e Frontend | 29/09/22 | 1.0.1 

    Fazendo o Deploy na Nuvem | 22/07/22 | 1.0.1

    Adicionado feature disparo de emails | 12/06/2022 | 1.0.1

    Finalizado Parcialmente | 21/05/2022 | 1.0.0 

    Corrigindo alguns bugs | 04/08/22 | 1.0.1 

    Adicionada tela de Registro fora da aplicacao | 03/08/22 | 1.0.1 

    Emissão Inicial | 26/03/2022 | 1.0.0
    


    ### 👥 Principais Tecnologia usadas até o momento
    


      
    


       
    

            
    PostgresSQL
    

            
    


       
     

       
    

            
    Nodejs
    

            

      
     

      
    

            
    Express
         

            

      
     
    


              
    


    1 - introdução
    


    Acumulando o mínimo de conhecimento de sistema de controle de acesso. Estou desenvolvendo meu proprio sistema de contole de acesso.

    Nessa para se localiza a API do projeto. Devido a dismebração ocorrida no dia **29/09/22**
    


    2- Desenvolvimento 🥵🧑‍🏭
    


    


    


    Novamente, como sempre como nos projetos anteriores utilizei arquitura **MVC**
    


    3- Como instalar 🧑‍🔧
    


    1.Tenha um **NODEjs** e **PostgresSQL 9.5** instalado.
    


    2. Clone o projeto.
    


    3. Restaure um backup do banco de dados postegresql. Localizado no caminho abaixo:
    


            \Model\18052022-dbjoaoacesso-c.sql
    


    


    4. Entre no Diretorio no **CMD ou em Outro terminal** de comando.
    


    5. Em seguida entre dentro da pasta **Aplics**.
    


            \    
    


    6. **ATENCAO** Após isso digite o npm install dotenv se caso o dotenv nao for instalado dentro da pasta Aplics.
    


    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:
    


                    PORT_SERVIDOR=
    


                    USERDB=

                    PORTDB=

                    HOSTDB=

                    DATABASE=

                    PASSWORD=
    


                    TOKEN_SECRET=
    


    Exemplo preenchido  .env:
    


                    PORT_SERVIDOR=3000
    


                    USERDB="postgres"

                    PORTDB=5432

                    HOSTDB="127.0.0.1"

                    DATABASE="db_joao_acesso_v1"

                    PASSWORD="admin"
    


                    TOKEN_SECRET="joao"
    


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


           npm start
    


    9. Esse comando irá iniciar o servidor....
    


    10 . Dentro da pasta Aplics há um Sistema-joao-acesso/Aplics/**API_Sistema_joao_acesso-Tipo-HAR**, poderá usar para Usar na API de 

    Teste, ***Insomnia ou postman*** de sua preferencia.
    


    4- Como usar 👩‍💻
    

    Veja mais na documentação da Aplicação
    


    Clique logo abaixo para ver o tutorial sobre o sistema.

    

    Clique aqui aprender com usar a solução👈
    


    5 -🥺😭 Considerações finais
    


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


    Pessoal estou aberto a sugestões de dica e opiniões, vale resaltar que ainda sou **Desenvolvedor Junior** ... Nesse sistema ainda falta implementar SocketOI para tela de monitoramento, entre outras coisas de resposividade e etc...🤗
    


    Muito obrigado a quem passar por aqui, Volte sempre 🤗🙋‍♂️!
    


    6 -📁😅🤪 Coisa não tão relevantes
    


    Na estrutura de diretorios há 2 pastas principais:
    


    ### Aplics 📁

    Onde estão todo o codigo fonte da Aplicação 

    ### Documents 🗃️📋 

    Onde estão esta colocado toda documentação, as 

    dependencias que eu estou usando entre outras coisa, serve para que eu lembre mesmo de todas 😅 

    ### what-Dependecias

    Meu gerador de arquivos quando preciso gerar algo repetivo, comando para lembra ou outras coisa crio esse coisinham para automatizar. 😅

    ### fileCreatorServer.bat ⚙️

    Meu gerador de estrutura de codigo. Ele gera minhas pasta principais do Back-end. Otimizando o tempo na criacão de diretórios e arquivos. 🤗Ahh vale resaltar ele é baseado no **MVC**.
    


    ### Autor ✍🏻
    


    ---
    


     

     
    

     Joao Guilherme 🚀
    


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


    [![Linkedin Badge](https://img.shields.io/badge/-Joao-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/jaoo/)](https://www.linkedin.com/in/joaog123/) 

    [![Badge](https://img.shields.io/badge/[email protected]?style=flat-square&logo=Microsoft&logoColor=white&link=mailto:[email protected])](mailto:[email protected])
    


    8 - Licença
    


    [![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)