Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Desafio full-stack #57

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 13 additions & 22 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
# Local
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
*.local
*.log*

# Dist
node_modules
dist/
coverage

# IDE
.vscode/*
!.vscode/extensions.json
.idea
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Lock files
package-lock.json
pnpm-lock.yaml
yarn.lock
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"singleQuote": true,
"semi": false,
"trailingComma": "none",
"arrowParens": "avoid"
}
60 changes: 60 additions & 0 deletions PULL_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## Aplicação de TODO's

Aplicação criada para o gerenciamento de TODO's

#### Funcionalidades
- Criação, edição, listagem e deleção de TODO's
- Filtros para a listagem de TODO's
- Paginanação para a listagem de TODO's

#### Principais tecnologias utilizadas

Front-end

- React
- Typescript
- Sass
- Rsbuild
- Jest
- React-testing-library

Back-end

- NestJS
- Typescript
- MongoDB
- Docker

### Como executar

**Pré-requisitos**
- [NodeJS](https://nodejs.org/pt)
- [Docker](https://docs.docker.com/)

Primeiro, é preciso executar o servidor, basta abrir o repositório backend e executar os seguintes comandos em sequência
```bash
# Instala todas as dependências do projeto
npm install

# Executa o projeto na porta 3002
docker-compose up -d --build
```

Logo após, a aplicação front-end pode ser executado, basta abrir o repositório frontend e executar os seguintes comandos em sequência
```bash
# Instala todas as dependências do projeto
npm install

# Executa a aplicação na porta 3000
npm run dev
```

#### Algumas informações que podem ser imporantes quando tomei algumas decisões

- **Escolhe do banco de dados**: Como é uma aplicação bem simples, que não tem uma quantidade muito grande de dados, que não tem vários "registros" que se relacionam e que tem uma complexidade relativamente baixa, decidi utilizar o Mongodb, um NoSQL já resolveria o problema.

- **Escolha do framwork backend**: Utilizei o NestJS por estar mais familiarizado com o framework.

- **Escolhe na inicialização da aplicação React**: Vi que o projeto base foi construido utilizando o CRA, como ele foi descontinuado e não terá suporte para futuras versões, utilizei o boilerplate do RsBuild, que além de ainda ser mantido, também utiliza Rust para a criação do bundler da aplicação, que é mais performatico que o webpack, utilizado no CRA.

- **A listagem está paginada**
31 changes: 31 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
import js from '@eslint/js';
import reactHooks from 'eslint-plugin-react-hooks';
import reactJsx from 'eslint-plugin-react/configs/jsx-runtime.js';
import react from 'eslint-plugin-react/configs/recommended.js';
import globals from 'globals';
import ts from 'typescript-eslint';

export default [
{ languageOptions: { globals: globals.browser } },
js.configs.recommended,
...ts.configs.recommended,
...fixupConfigRules([
{
...react,
settings: {
react: { version: 'detect' },
},
},
reactJsx,
]),
{
plugins: {
'react-hooks': fixupPluginRules(reactHooks),
},
rules: {
...reactHooks.configs.recommended.rules,
},
},
{ ignores: ['dist/'] },
];
9 changes: 9 additions & 0 deletions fileTransformer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
const path = require('path');

module.exports = {
process(_, sourcePath) {
return {
code: `module.exports = ${JSON.stringify(path.basename(sourcePath))};`,
};
},
};
21 changes: 21 additions & 0 deletions jest.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"moduleDirectories": ["node_modules", "src"],
"moduleNameMapper": {
".+\\.(css|styl|less|sass|scss|png|jpg|ttf|woff|woff2)$": "<rootDir>/fileTransformer.js"
},
"transform": {
".(ts|tsx)$": "ts-jest"
},
"setupFilesAfterEnv": [
"<rootDir>/src/setup-test.ts"
],
"testEnvironment": "jsdom",
"coveragePathIgnorePatterns": [
"/node_modules/",
"/coverage",
"package.json",
"package-lock.json",
"/src/setup-test.ts",
"index.tsx"
]
}
Loading