Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 2.97 KB

README.md

File metadata and controls

84 lines (62 loc) · 2.97 KB

📚 Lectrus Care

Lectrus Care é uma aplicação desktop multiplataforma focada na gestão e regularização de pagamentos escolares. Desenvolvida com Electron e Vite, a aplicação combina desempenho optimizado e uma interface moderna, permitindo aos centros de ensino gerir matrículas, pagamentos e comunicação de forma eficiente.


🚀 Funcionalidades Principais

  • Gestão de Estudantes: Pesquisa e gestão de estudantes pelo nome ou código.
  • Gestão de Pagamentos: Registro e acompanhamento de pagamentos com cálculo automático de taxas de multa.
  • Histórico de Matrículas: Acesso ao histórico de matrículas e propinas associadas.
  • Interface Multiplataforma: Compatível com Windows, macOS e Linux.

🛠️ Tecnologias Utilizadas

Tecnologia Aplicação
Electron Construção de aplicações desktop multiplataforma.
Vite Ferramenta de desenvolvimento rápida e leve.
React.js Criação da interface do utilizador (frontend).
React Hook Form Gestão e validação de formulários.
Yup Validação de dados de formulários.
TypeScript Tipagem estática para maior segurança e robustez.
TailwindCSS Estilização moderna e responsiva.

📂 Estrutura do Projeto

Lectrus-Care/
├── src/
│   ├── components/     # Componentes reutilizáveis
│   ├── contexts/       # Contextos para gestão de estado global
│   ├── pages/          # Páginas principais da aplicação
│   ├── services/       # Serviços de integração com APIs
│   ├── utils/          # Funções auxiliares (e.g., formatação)
│   └── styles/         # Configurações de estilos globais
├── public/             # Recursos estáticos (imagens, ícones, etc.)
└── main/               # Arquivos principais para Electron

---

# 🔧 **Como Configurar o Projeto**

## **Pré-requisitos**

- **Node.js** (versão LTS recomendada).
- **Git**.
- Gerenciador de pacotes: **Yarn** ou **npm**.

---

## **Passo a Passo**

### 1. Clone o repositório:
git clone https://github.com/seu-usuario/lectrus-care.git
cd lectrus-care
2. Instale as dependências:
npm install
# ou
yarn install
3. Configuração do ambiente:
Crie um ficheiro .env na raiz do projecto.
Adicione as variáveis necessárias para integração com as APIs (exemplo: URL da API, chave de autenticação).
4. Inicie o ambiente de desenvolvimento:
npm run dev
# ou
yarn dev

---
🤝 Contribuições
Contribuições são sempre bem-vindas! Siga os passos:

Faça um fork do repositório.
Crie uma nova branch para sua funcionalidade ou correcção:

Faça as alterações e crie um commit:
Envie suas alterações:
Abra um **pull request** para revisão.