-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,65 @@ | ||
# EscolaEfficient | ||
# EscolaEfficient | ||
|
||
EscolaEfficient é um sistema de gestão escolar desenvolvido utilizando Node.js, JavaScript, Twig e MongoDB. | ||
|
||
## Recursos | ||
|
||
- **Gerenciamento de Alunos e Professores:** Cadastro, edição e exclusão de informações. | ||
- **Sistema de Empréstimos de Livros:** Controle de empréstimos e devoluções de livros. | ||
- **Autenticação e Autorização:** Login seguro para diferentes tipos de usuários (administrador, professor, aluno). | ||
- **Interface de Usuário:** Utilização do Twig para renderização de templates. | ||
- **Banco de Dados:** Integração com MongoDB para armazenamento de dados. | ||
|
||
## Tecnologias Utilizadas | ||
|
||
- Node.js | ||
- Express.js | ||
- JavaScript | ||
- Twig | ||
- MongoDB | ||
- Mongoose | ||
|
||
|
||
|
||
## Estrutura do Projeto | ||
|
||
O projeto está estruturado da seguinte forma: | ||
|
||
```plaintext | ||
EscolaEfficient/ | ||
│ | ||
├── public/ # Frontend | ||
│ ├── assets/ # Recursos estáticos (imagens, fontes) | ||
│ ├── scripts/ # Scripts JavaScript do frontend | ||
│ ├── styles/ # Arquivos de estilo (CSS, Sass) | ||
│ └── views/ # Arquivos HTML das views | ||
│ └── templates/ # Templates reutilizáveis | ||
│ | ||
└── src/ # Backend | ||
├── controllers/ # Controladores para cada entidade | ||
├── dto/ # DTOs (Data Transfer Objects) | ||
├── models/ # Modelos do Mongoose (ou ORM equivalente) | ||
├── routes/ # Definição de rotas | ||
├── services/ # Lógica de negócios (serviços) | ||
└── templates/ # Templates para renderização de views | ||
``` | ||
|
||
## Contribuição | ||
|
||
Sinta-se à vontade para contribuir com o projeto. Para isso, siga os passos abaixo: | ||
|
||
## Instalação | ||
|
||
### Pré-requisitos | ||
|
||
- Node.js | ||
- MongoDB | ||
- Twig | ||
|
||
1. Faça um fork do projeto clicando no botão "Fork" no canto superior direito da página do repositório. | ||
|
||
2. Clone o seu fork localmente: | ||
|
||
```bash | ||
git clone https://github.com/seu-usuario/EscolaEfficient.git | ||
cd EscolaEfficient |