Biblioteca Universitária

Sobre • Protótipo do projeto • Tecnologias • Estrutura de diretórios

Como executar o projeto • Como executar os testes unitários • Padrões de commit • Regras de Codificação

✨ Sobre

O sistema implementado tem o objetivo de ajudar na organização de uma biblioteca universitária, possibilitando o controle de empréstimo dos livros. Os funcionários serão responsáveis por cadastrar os alunos, os livros, e as informações referentes ao empréstimo.

💄 Protótipo do projeto

• Figma

🚀 Tecnologias

• Node - v14.17.0
• React - v17.0.2
• SQLite - v5.0.2
• Knex - v0.95.13
• Objection - v3.0.0
• Express - v4.17.1
• Nodemon - v2.0.14
• Bcryptjs - v2.4.3
• Axios - v0.24.0
• Date-fns - v2.25.0

📂 Estrutura de diretórios

├── Codigo
│   ├── backend
│   │    └── __tests__
│   │        └── database
│   │             └── unitarios
│   │             └── validação
│   └── frontend
├── Padrões Adotados
└── Requisitos
    └── Diagramas de Projeto
        └── Diagrama de Caso de Uso
        └── Diagrama de Classe
        └── Diagrama de Implantação
        └── Diagrama de Sequencia

🤔 Como executar o projeto

🚨 Pré requisito

Antes de começar, você vai precisar ter instalado em sua máquina o Node.js. De modo opcional, seria interessante também ter instalado o gerenciador de pacotes yarn.

# Clone este repositório
$ git clone https://github.com/mariaseverino/projeto-final.git

# Acesse a pasta do projeto
$ cd projeto-final

📁 Backend

# Acesse a pasta do backend
$ cd Codigo/backend

# Instale as dependências
$ npm install

# Execute a aplicação
$ npm start

# Rodando em http://localhost:3333

🎲 Frontend

# Acesse a pasta do frontend
$ cd Codigo/frontend

# Instale as dependências
$ npm install

# Execute a aplicação
$ npm start

# Rodando em http://localhost:3000

Obs: Caso tenha o yarn instalado

# Instale as dependências
$ yarn

# Execute a aplicação
$ yarn start

🧐 Como executar os testes unitários

Os testes unitários foram realizados utilizando Jest

No windows, altere os scripts do arquivo package.json de:

Versão ubuntu

"scripts": {
       "start": "nodemon src/server.js --ignore __tests__",
       "pretest": "NODE_ENV=test knex migrate:latest",
       "test": "NODE_ENV=test jest",
       "posttest": "NODE_ENV=test knex migrate:rollback --all"
   }

Para:

Versão Windows

"scripts": {
       "start": "nodemon src/server.js --ignore __tests__",
       "pretest": "SET NODE_ENV=test&&knex migrate:latest",
       "test": "jest",
       "posttest": "SET NODE_ENV=test&&knex migrate:rollback --all"
   }

Para realização dos testes execute os seguintes comandos:

# Acesse a pasta do backend
$ cd Codigo/backend

# Execução
$ npm test

Caso esteja utilizando o yarn:

# Acesse a pasta do backend
$ cd Codigo/backend

# Execução
$ yarn test

👷 Regras de Codificação

• Utilizar indentação, de maneira correta e padronizada;

  • Utilizar tabulações;

• Utilizar nomes de atributos e funções significativos e autoexplicativos;

  • Ex: cadastrar, buscar, etc;

• Utilizar inicial minúscula em nomes de atributos e funções;

• Utilizar inicial maiúscula em nomes de classes;

• Utilizar apenas formato de comentário de blocos ao comentar o código;

• Informar em comentário a descrição de funções e seus parâmetros de forma clara e objetiva;

• Utilizar bloco try/catch com as devidas mensagens de erro em tentativas de acessos de funcionalidades;

📌 Padrões de commit

• Utilizar verbos no gerúndio
• Fazer referência ao requisito que esta sendo desenvolvido ou foi implementado