From dc442f6d267f45a97475b51329a229eb8080eed3 Mon Sep 17 00:00:00 2001 From: Douglas Barone Date: Tue, 17 Nov 2020 17:01:41 -0400 Subject: [PATCH] Updated READMEs --- README.md | 35 +++++++++++++++++++++++++++++++++++ server/README.md | 5 ++--- web/README.md | 17 +++++------------ 3 files changed, 42 insertions(+), 15 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebb378f --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Portal de TI + +Portal concentrador de alguns serviços auxiliares de Tecnologia da Informação para usuários e administradores. Envie sua sugestão para serti.pp@ifms.edu.br + + +# Funcionalidades + +- Informações sobre a conta do usuário +- Crachá virtual com validação +- Alteração de senha do usuário com verificação de força de senha +- Presença de usuários no campus com busca e localização aproximada +- Token de redefinição de senha para estudantes +- Redefinição direta de senha para administradores com senha padrão, gerada ou personalizada +- Busca e inspeção de usuário (preview) + +## Informações adicionais +- Integração com Active Directory +- Integração com sistema UniFi +- Cliente Web PWA (necessita https) + + +# Roadmap + +## Em desenvolvimento / Planejado +- Busca e inspeção de usuário +- Informação sobre recursos (ex.: pastas de rede) + +## Em análise +- Integração com controladora Cisco WLC +- Integração Palo Alto +- Cadastro de dispositivos (bypass de autenticação) +- App mobile + +--- +Desenvolvido pelo SERTI de Ponta Porã. \ No newline at end of file diff --git a/server/README.md b/server/README.md index 86e2ff3..15a336e 100755 --- a/server/README.md +++ b/server/README.md @@ -1,4 +1,4 @@ -# IFMS - Portal de TI - Server +# Portal de TI - Server Servidor de API GraphQL para o Portal de TI do IFMS ## Requisitos @@ -15,12 +15,11 @@ Altere as variáveis de ambiente em `.env` ~~~ docker-compose up -d -npm run prisma-deploy # Rodar sempre que alterar o Datamodel +npm run prisma-deploy # Rodar sempre que alterar o schema npm run dev ~~~ ## Compilar para produção -Altere a variável `secret:` em `prisma.yml` ~~~ npm run prisma-deploy npm run build diff --git a/web/README.md b/web/README.md index 190f5e0..88e592b 100755 --- a/web/README.md +++ b/web/README.md @@ -1,25 +1,18 @@ -# Portal de TI +# Portal de TI - Web Client -## Project setup +## Desenvolvimento ``` npm install npm get-schema -``` - -### Compiles and hot-reloads for development -``` npm run serve ``` -### Compiles and minifies for production +### Compilar para produção ``` npm run build ``` -### Lints and fixes files +### Lint ``` npm run lint -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +``` \ No newline at end of file