Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gonzagadavid/priority-list-fullstack
Aplicação desenvolvida com React js, Redux, Express e MongoDB, tendo como proposito otimizar a organização e produtividade das pessoas. De forma visual, a pessoa poderá organizar sua lista de tarefas, classificando a tarefa por nível de prioridade, status e data
https://github.com/gonzagadavid/priority-list-fullstack
axios express fullstack jest mongodb nodemon reactjs redux redux-thunk supertest swagger swagger-ui testing-library
Last synced: about 9 hours ago
JSON representation
Aplicação desenvolvida com React js, Redux, Express e MongoDB, tendo como proposito otimizar a organização e produtividade das pessoas. De forma visual, a pessoa poderá organizar sua lista de tarefas, classificando a tarefa por nível de prioridade, status e data
- Host: GitHub
- URL: https://github.com/gonzagadavid/priority-list-fullstack
- Owner: Gonzagadavid
- License: mit
- Created: 2022-02-17T15:36:37.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-11T01:30:49.000Z (over 2 years ago)
- Last Synced: 2023-03-04T17:37:26.645Z (over 1 year ago)
- Topics: axios, express, fullstack, jest, mongodb, nodemon, reactjs, redux, redux-thunk, supertest, swagger, swagger-ui, testing-library
- Language: JavaScript
- Homepage: https://todo-list-frontend-green.vercel.app/
- Size: 3.74 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Priority List - Full Stack
Visite a Aplicação
Repositório Lista de Prioridades - Backend
---
Repositório Lista de Prioridades - Frontend
---
# Sumário
- [Introdução](#introdução)
- [Instruções](#instruções)
- [Frontend](#Frontend)
- [Detalhes da aplicação](#detalhes)
- [Login](#login)
- [Cadastro](#cadastro)
- [Página Inicial](#página-inicial)
- [Adicionar uma nova tarefa](#adicionar-uma-nova-tarefa)
- [Lista de Tarefas](#lista-de-tarefas)
- [Detalhes da Tarefa](#detalhes-da-tarefa)
- [Editar Tarefa](#editar-tarefa)
- [Tecnologias](#tecnologias)
- [Testes](#testes)
- [Deploy](#deploy)
- [Backend](#backend)
- [Arquitetura](#Arquitetura)
- [Documentação Swagger](#Documentação-Swagger)
- [Rotas](#rotas)
- [POST /user](post-/user)
- [POST /user/login](post-/user/login)
- [POST /task](post-/task)
- [GET /task](get-/task)
- [GET /task/:id](get-/task/:id)
- [PUT /task/:id](put-/task/:id)
- [DELETE /task/:id](delete-/task/:id)
- [Banco de Dados](#banco-de-dados)
- [Validação](#validação)
- [Tecnologias](#tecnologias)
- [Testes](#testes)
- [Deploy](#deploy)
- [Implementações Futuras](implementações-futuras)
# Intordução
O desenvolvimento da aplicação Lista de Prioridades teve como proposito otimizar a organização e produtividade das pessoas. De forma visual, a pessoa poderá organizar sua lista de tarefas, classificando a tarefa por nível de prioridade, status e data.
# Instruções
1 - abra o terminal
2- clone o repositório do full stack `git clone [email protected]:Gonzagadavid/todo-list-fullstack.git`
3- entre no diretório do repositorio clonado `cd todo-list-fullstack`
4- entre no diretório do backend `cd backend`
5- execute o comando para instalar as dependências `npm install`
6- preencha o arquivo `.env-eg` com os dados do seu banco de dados MongoDB local e mude o nome do arquivo para `.env`
*caso não tenha o MongoDB instalado siga o seguinte [tutorial](https://docs.mongodb.com/manual/installation/)*
7- execute o comando para iniciar o servidor `npm start`
7- abra um nova janela do terminal no diretorio `todo-list-fullstack`
9- entre no diretório do frontend `cd frontend`
10- execute o comando para instalar as dependências `npm install`
11- no arquivo `./src/redux/thunks/endpoints.js` comente as linha com endpoints de produção e descomente os endpoints para rodar localmente
12- execute o comando para iniciar a aplicação `npm start`
13- a aplicação iniciará em `http://localhost:3000`
# Frontend
# Detalhes
## Login
Ao iniciar o uso da aplicação será renderizado a tela de login, onde a pessoa usuária terá que informar o e-maile a senha, o botão `Entrar` será habilitado somente com todos os campos preenchidos, tendo como opção a pessoa manter-se logada na aplicação mesmo após fechar o navegador. Caso a pessoa não tenha cadastro, basta clicar no botão de cadastrar que a aplicação renderizará o formulário de registro.
## Cadastro
Após a pessoa usuária clicar no botão cadastrar será renderizado o formulário de cadastro, a pessoa terá que informar nome, sobrenome, e-mail, senha e confirmar a senha, somente com esses campos preenchidos o botão 'Cadastrar' será habilitado. Após o registro ser feito o login será feito, porém só será válido durante a primeira sessão, sendo necessário o login na proxima sessão.
## Página inicial
Depois de logar a página principal será renderizada, exibindo uma saudação com o nome da pessoa usuária no canto superior direito, junto ao botão de sair. A aplicação exibe dois container, um para exibir a lista de tarefas e um para exibir os detalhes das tarefas.
## Adicionar uma nova tarefa
Na parte superior da lista de tarefas é localizado um botão para adicionar um nova tarefa, ao clicar no botão será renderizado um formulário para adicionar a tarefa, com os seguintes campos: titulo, descrição, status e prioridade.
## Lista de tarefas
Na lista de tarefas a pessoa usuária tem as opções de ordenar as tarefas por: prioridade, titulo, status e data, ao clicar em uma tarefa o detalhes da tarefa selecionada será exibido em Detalhe da Tarefa
## Detalhes da tarefa
A tarefa selecionada na lista de tarefas será renderizada com os seguites detalhes: Título, prioridade, status, descrição, publicada em e modificada em. Em detalhes da tarefa também está localizado os botões para remover a tarefa e edita-la.
## Editar tarefa
Ao clicar no botão de `editar tarefa` a tarefa selecionada será renderizada em um formulario para a modificação.
# Tecnologias
- React
- Redux
- Testing Library
- Axios
- Eslint
# Testes
Desenvolvido testes unitários para os componentes Login e Signup
Para executar os testes implementado execute o comando `npm test`
Para verificar a cobertura de test execute o comanto `npm run coverage`
# Deploy
# Deploy
Para o deploy da aplicação foi escolhido a [Vercel](#https://vercel.com/)
Visite a Aplicação
# Futuras implementações
- cobertura de teste em 100% da aplicação
- implementar página para a pessoa adminitradora direcionar tarefas para outras pessoas usuárias
---
# Backend
# Arquitetura
Sequindo o formato da arquitetura em camadas MSC *(Model Service Controllers)*, a estruturação do código foi feito de forma tornar o código légivel e de fácil entendimento, visando o reaproveitamento e não gerar problemas para a implementação de futuras melhorias, novas funcionalidades e escalabilidade.
# Documentação Swagger
Para acessar a documentação swagger:
Produção: https://priority-list.adaptable.app/docs/
Local: `http://localhost:3800/docs/`
# Rotas
## POST /user
A rota `POST /user` foi desenvolvida para o registro de novas pessoas usuárias da aplicação.
entrada:
```json
{
"body": {
"name": "usuario1",
"lastname": "dos Testes",
"email": "[email protected]",
"password": "123456"
}
}
```
saída *(status: 201)*:
```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3MjU1Nn0.iK8x5uDNJMVHEv6OX7KK_T1J5KASEQvbgqXZc3Q1I2M",
"_id": "620dd0ac8db477bdc0735662",
"name": "usuario1",
"lastname": "dos Testes",
"email": "[email protected]"
}
```
## POST /user/login
A rota `POST /user/login` foi desenvolvida para que a pessoa usuária registrada no banco de dados possa logar na aplicação.
entrada:
```json
{
"body": {
"email": "[email protected]",
"password": "123456"
}
}
```
saída *(status: 202)*:
```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3MjU1Nn0.iK8x5uDNJMVHEv6OX7KK_T1J5KASEQvbgqXZc3Q1I2M",
"_id": "620dd0ac8db477bdc0735662",
"name": "usuario1",
"lastname": "dos Testes",
"email": "[email protected]"
}
```
## POST /task
A rota `POST /task` foi desenvolvida para a inseção de uma nova tarefa no banco de dados.
entrada:
```json
{
"body": {
"priority": "1",
"title": "Tarefa 1",
"description":"Descrição da tarefa 1",
"status": "peding"
},
"headers": {
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3Mjg0Mn0.dotM8NeQM0MoBS_5oZrM0rCh6DR77rO6sNDQJAozDL8"
}
}
```
saída *(status: 201)*:
```json
{
"message": "Task created successfully"
}
```
## GET /task
A rota `GET /task` foi desenvolvida para buscar todas as tarefas da pessoa usuária no banco de dados.
entrada:
```json
{
"headers": {
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3Mjg0Mn0.dotM8NeQM0MoBS_5oZrM0rCh6DR77rO6sNDQJAozDL8"
}
}
```
saída *(status: 200)*:
```json
[
{
"priority": "1",
"title": "Tarefa 1",
"status": "peding",
"created": "2022-02-17T04:46:57.036Z",
"_id": "620dd3418db477bdc0735663"
},
{
"priority": "1",
"title": "Tarefa 2",
"status": "inProcess",
"created": "2022-02-17T04:49:45.831Z",
"_id": "620dd3e98db477bdc0735664"
},
{
"priority": "2",
"title": "Tarefa 3",
"status": "inProcess",
"created": "2022-02-17T04:49:57.134Z",
"_id": "620dd3f58db477bdc0735665"
}
]
```
## GET /task/:id
A rota `GET /task/:id` foi desenvolvida para buscar e retornar os dados completos de uma tarefa pelo seu id.
entrada:
```json
{
"headers": {
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3Mjg0Mn0.dotM8NeQM0MoBS_5oZrM0rCh6DR77rO6sNDQJAozDL8"
}
}
```
saída *(status: 200)*:
```json
{
"_id": "620dd3e98db477bdc0735664",
"userId": "620dd0ac8db477bdc0735662",
"title": "Tarefa 2",
"description": "Descrição da tarefa 2",
"priority": "1",
"status": "inProcess",
"created": "2022-02-17T04:49:45.831Z",
"updated": "2022-02-17T04:49:45.831Z"
}
```
## PUT /task/:id
A rota `PUT /task/:id` foi desenvolvida para atualizar e retornar os dados completos de uma tarefa pelo seu id.
entrada:
```json
{
"body": {
"priority": "4",
"title": "Tarefa 2 (editada)",
"description":"Descrição da tarefa 2 (editada)",
"status": "completed"
},
"headers": {
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3Mjg0Mn0.dotM8NeQM0MoBS_5oZrM0rCh6DR77rO6sNDQJAozDL8"
}
}
```
saída *(status: 200)*:
```json
{
"_id": "620dd3e98db477bdc0735664",
"userId": "620dd0ac8db477bdc0735662",
"title": "Tarefa 2 (editada)",
"description": "Descrição da tarefa 2 (editada)",
"priority": "4",
"status": "completed",
"created": "2022-02-17T04:49:45.831Z",
"updated": "2022-02-17T04:59:43.867Z"
}
```
## DELETE /task/:id
A rota `DELETE /task/:id` foi desenvolvida para remover uma tarefa do banco de dados pelo seu id.
entrada:
```json
{
"headers": {
"authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjYyMGRkMGFjOGRiNDc3YmRjMDczNTY2MiIsImVtYWlsIjoidXN1YXJpbzFAZW1haWwuY29tIn0sImlhdCI6MTY0NTA3Mjg0Mn0.dotM8NeQM0MoBS_5oZrM0rCh6DR77rO6sNDQJAozDL8"
}
}
```
saída *(status: 202)*:
```json
{
"message": "task removed successfully"
}
```
# Banco de dados
O banco de dados usado para aplicação foi o MongoDB, sendo ele um banco não relacional, tornou-se uma excelente opção para uma aplicação, pois a relação entre os dados da aplicação são simples.
# Validação
Para a validação de entrada foi desenvolvido middlewares, dessa forma evitando o desperdício de recursos com requisições inválidas. Para gerar e validar o token foi utilizado o jsonwebtoken, podendo utilizar informações da pessoa usuária contidas no payload para registro de suas ações evitando uso de recursos para obter essas informações.
# Tecnologias
- NodeJs
- Express
- Nodemon
- Jest
- Supertest
- MongoDB
- Json Web Token
- Dotenv
- ESlint
# Testes
Desenvolvido teste de integração para a rota `POST /user`
Para rodar os teste implementado basta executar o comando `npm test`
# Deploy
Deploy feito no heroku [Heroku](https://www.heroku.com/)
Visite a Aplicação
# Implementações Futuras
- 100% cobertura de testes
- rota de pessoa administradora para direcionar tarefas.