Files
dockerfluxodecaixapro/rules/13_USER_GUIDE.md
T
2026-09-01 10:46:29 -03:00

184 lines
6.4 KiB
Markdown
Executable File

# SysCMS - Guia do Usuário
## Bem-vindo ao SysCMS
O SysCMS é um Sistema de Gerenciamento de Conteúdo (CMS) modular, poderoso e flexível, projetado para permitir a criação, gerenciamento e publicação de conteúdo de forma simples e eficiente. Este guia foi elaborado para ajudar você a navegar e utilizar todas as funcionalidades do sistema, desde a instalação até o gerenciamento avançado.
---
## 🚀 Instalação e Configuração Inicial
O SysCMS conta com um instalador web moderno e automatizado para facilitar a configuração inicial.
### Passo a Passo da Instalação
1. **Acesse o Instalador**:
Abra seu navegador e digite a URL onde o sistema está hospedado, adicionando `/install` ao final (ex: `http://localhost/install` ou `http://seudominio.com/install`).
2. **Verificação de Requisitos**:
O sistema verificará automaticamente se seu servidor atende aos requisitos mínimos (PHP 8.1+, extensões necessárias e permissões de escrita). Se tudo estiver verde, clique em **Próximo**.
3. **Configuração do Banco de Dados**:
Insira os dados de conexão com seu banco de dados MySQL:
- **Host**: Geralmente `localhost` ou o nome do serviço do banco (ex: `mysql` em ambientes Docker).
- **Nome do Banco**: O nome do banco de dados que você criou para o SysCMS.
- **Usuário**: Usuário do banco de dados.
- **Senha**: Senha do banco de dados.
Clique em **Testar Conexão**. Se bem-sucedido, avance.
4. **Configuração do Sistema**:
Defina as informações básicas do seu site:
- **Nome da Aplicação**: Nome do seu projeto/site.
- **URL da Aplicação**: URL base do site (ex: `http://localhost`).
- **Dados do Super Admin**: Crie a conta do administrador principal (Nome, Email e Senha).
5. **Instalação**:
O sistema irá automaticamente:
- Gerar o arquivo de configuração (`.env`).
- Importar a estrutura do banco de dados.
- Criar o usuário Super Admin.
6. **Conclusão**:
Após a mensagem de sucesso, você será redirecionado para a tela de login.
> **⚠️ IMPORTANTE:** Por segurança, após a instalação, remova a pasta `public/install` do servidor.
---
## Acessando o Sistema
### Login
Para acessar o painel administrativo do SysCMS:
1. Abra seu navegador e acesse a URL do sistema.
2. Clique no botão "Login" no menu superior (se visível) ou acesse `/login`.
3. Digite seu email e senha cadastrados.
4. Clique em "Entrar".
### Recuperação de Senha
Caso esqueça sua senha:
1. Na página de login, clique em "Esqueci minha senha".
2. Digite seu email cadastrado.
3. Siga as instruções enviadas para seu email para redefinir a senha.
---
## Painel Administrativo
### Visão Geral
O painel administrativo foi projetado para ser intuitivo:
- **Barra Lateral**: Menu de navegação principal com acesso a todos os módulos.
- **Área Principal**: Onde você gerencia o conteúdo e as configurações.
- **Barra Superior**: Informações do usuário logado, notificações e atalhos rápidos.
### Menu Principal
O menu lateral organiza as funcionalidades:
- **Dashboard**: Visão geral com estatísticas e atividades recentes.
- **Páginas**: Gerenciamento de conteúdo estático.
- **Posts**: Gerenciamento de blog/notícias.
- **Vitrine**: Gerenciamento de produtos e serviços.
- **Usuários**: Administração de usuários e permissões.
- **Configurações**: Ajustes gerais do sistema e da empresa.
---
## Gerenciamento de Conteúdo
### Páginas
Ideal para conteúdo institucional (ex: Sobre Nós, Contato, Termos de Uso).
#### Criando uma Nova Página
1. No menu lateral, clique em **Páginas** > **Nova Página**.
2. Preencha:
- **Título**: Nome da página.
- **Conteúdo**: Utilize o editor visual para formatar seu texto e adicionar mídia.
- **Status**: Defina como `Publicado` para exibir ou `Rascunho` para salvar e editar depois.
3. Clique em **Salvar**.
### Posts
Ideal para conteúdo dinâmico e recorrente (ex: Blog, Notícias).
#### Criando um Novo Post
1. Vá em **Posts** > **Novo Post**.
2. Preencha título, conteúdo, resumo e selecione uma **Categoria**.
3. Adicione **Tags** para facilitar a busca.
4. Defina uma **Imagem de Destaque**.
5. Publique ou salve como rascunho.
### Vitrine
Ideal para exibir produtos, serviços ou portfólio.
#### Adicionando um Item
1. Acesse **Vitrine** > **Novo Item**.
2. Preencha título, descrição, preço (opcional) e conteúdo detalhado.
3. Carregue imagens para a galeria do produto.
4. Defina a visibilidade e categoria.
5. Salve o item.
---
## Gerenciamento de Usuários
### Níveis de Acesso
- **Super Admin**: Acesso total ao sistema, incluindo configurações críticas e instalação de módulos.
- **Admin**: Gerencia conteúdo, usuários e configurações da empresa.
- **Usuário**: Acesso básico, geralmente limitado ao próprio perfil ou áreas públicas restritas.
### Criando Usuários
1. Vá em **Usuários** > **Novo Usuário**.
2. Preencha nome, email, senha e defina a **Função** (Role).
3. Ative o usuário e salve.
---
## Configurações do Sistema
### Configurações Gerais
Ajuste o nome do site, descrição para SEO, email de contato, fuso horário e idioma padrão.
### Configurações de Empresa
Gerencie os dados da sua organização: Nome, Endereço, Contato e Logo. Essas informações são frequentemente usadas nos rodapés e cabeçalhos do site público.
---
## Dicas e Boas Práticas
### Organização
- Use categorias consistentes para Posts e Vitrine.
- Mantenha slugs (URLs amigáveis) curtos e descritivos.
- Revise o conteúdo antes de publicar.
### Segurança
- Use senhas fortes e únicas.
- Não compartilhe suas credenciais de acesso.
- Mantenha o sistema sempre atualizado.
- **Remova a pasta de instalação** após o setup inicial.
### Performance
- Otimize imagens antes de fazer upload (evite arquivos > 2MB se possível).
- Desative módulos que não estão em uso.
---
## Suporte
Se precisar de ajuda adicional:
1. Consulte este guia novamente.
2. Verifique a documentação técnica (se você for um desenvolvedor).
3. Entre em contato com o suporte técnico ou administrador do sistema.
---
**SysCMS** - *Simples, Modular, Poderoso.*