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.

Sign up for GitHub

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

Jump to bottom

contributing #3

Merged
merged 3 commits into from
Sep 30, 2024
Merged

contributing #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44c09c8
refactor: font-size headings
guiseek Sep 30, 2024
bd69967
chore: add seeds
guiseek Sep 30, 2024
2dadd23
docs: contributing guide
guiseek Sep 30, 2024
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
163 changes: 163 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Da hora ter você por aqui!

Quer contribuir com código? Nice 🤘

Aqui vão alguns passos pra executar o projeto em desenvolvimento.

## Requisitos

1. [node.js](https://nodejs.org/pt/download) v20+
1. [pnpm](https://pnpm.io/installation) instalado
1. [docker](https://docs.docker.com/engine/install) instalado

## Clone o projeto

```sh
git clone https://github.com/DeveloperParana/devmx
```

## Variáveis de ambiente

Configure a senha do banco e segredo jwt como quiser para uso local.

Para isso, renomeie o arquivo [`.env-example`](./.env-example) para `.env`

```sh
mv .env-example .env
```

## Docker

Essas variáveis são usadas no arquivo [docker-compose.yml](./docker-compose.yml).

> [!IMPORTANT]
> Primeiro preencha os valores para `DB_USER`, `DB_PASS`, `JWT_SECRET` no arquivo [.env](./.env), salve e só depois disso execute o docker.


```sh
docker compose up -d
```

## Instalação

Instale as dependências do projeto

```sh
pnpm install
```

## Execução

Execute o back-end para criar as collections no banco

```sh
pnpm dev:server
```

Assim que conluir, você já pode finalizar o processo (`Ctrl` + `C` / `Cmd` + `C`), pois você não quer criar dados úteis manualmente, certo?

## Seeds

Preparei alguns seeds pra você importar na base de dados, mas primeiro verifique se você tem o comando `mongoimport`, caso não tenha, acesse [este link](https://www.mongodb.com/pt-br/docs/database-tools/installation/installation/#installing-the-database-tools) para saber como instalar.

> [!NOTE]
> Ele é necessário apenas para importar dados iniciais não obrigatórios, como dados de login com permissões distintas e todas as cidades do brasil com latitude e longitude.


Para importar execute, não se esqueça de colocar seu usuário no `--username=seu-user` configurado no [`.env`](./.env). Ao executar, ele irá solicitar a senha que foi configurada no mesmo arquivo.

### Cidades

```sh
mongoimport --host=localhost --port=27017 --username= --authenticationDatabase=admin --db=devparana --collection=citycollections --file=assets/seeds/city-collection.json
```

### Usuários

```sh
mongoimport --host=localhost --port=27017 --username= --authenticationDatabase=admin --db=devparana --collection=accountcollections --file=assets/seeds/account-collection.json
```

## Agora sim!

Agora tudo está configurado pra você executar em desenvolvimento, configurei a execução do back-end e front-end no mesmo comando a seguir.

```sh
pnpm dev
```

## Convenção usada em commits

> [!WARNING]
> Antes de escrever seu commit, execute `lint`, `test` e `build` dos projetos afetados pela sua alteração com o comando `pnpm affected`.

Os commits podem ser feitos em português, mas use inglês para termos técnicos, não tente traduzi-los quando eles são conhecidos e usados em inglês, por gentileza.

> [!TIP]
> Use o comando `pnpm commit`, e apenas responda as perguntas, assim seu commit seguirá a convenção utilizada.


## Arquitetura

Trata-se de responsabilidade e relacionamentos, ou seja, qual a responsabilidade de cada camada e quais camadas podem depender diretamente uma das outras. Esta é uma convenção chamada [enforce module boundaries](https://nx.dev/features/enforce-module-boundaries#enforce-module-boundaries) e quem permite que as regras sejam aplicadas é o [nx](https://nx.dev).

### Responsabilidades e relacionamentos entre tipos de bibliotecas


A tabela a seguir representa a configuração no arquivo [`.eslintrc.json`](.eslintrc.json).

| | api | util | domain | data | ui | feature | resource | app |
| ---------: | :-: | :--: | :----: | :--: | :-: | :-----: | :------: | :-: |
| `api` | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `util` | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `domain` | ✓ | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `data` | ✓ | ✓ | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `ui` | ✓ | ✓ | 𝗫 | 𝗫 | ✓ | 𝗫 | 𝗫 | 𝗫 |
| `feature` | ✓ | ✓ | 𝗫 | ✓ | ✓ | ✓ | 𝗫 | 𝗫 |
| `resource` | ✓ | ✓ | 𝗫 | ✓ | 𝗫 | 𝗫 | ✓ | 𝗫 |
| `app` | ✓ | ✓ | 𝗫 | ✓ | ✓ | ✓ | ✓ | 𝗫 |

Caso tenha interesse em aprofundar neste assunto e descobrir os motivos, recomendo que leia um conteúdo que escrevi ano passado, você pode fazer download através do link [Arquitetura em camadas, uma abordagem sobre responsabilidades e relacionamentos](https://conteudode.dev/pdf/nx).


---


```
..........
..............
..................
........................
............................
................................
....................................
........................................
.................. ...................
............ ..... ...... ....................
............ ... ... ...... ......................
.............. .... ... .... ..............
........ ..... ..... ..... .... ...............
........ ...... ....... ..... . .... .........
......... .... ...... ....... ....... .... ... .........
............. ...... .... ........ ..... ... ............
................ ........... ........ ...... ...............
................ ................. ..... ........ ................
................ ................ ......... ................
................. .............. ............... ................
.................. .... ................. ...............
.................... ................. ............
........................... ............... ...........
............................ ....... ..........
.......................... . ............
........................ ....................
...................... ......................
................... ...................
................. .................
............... ...............
............. .............
........... ...........
:........ .........
...... ......
.... ....
.. ..
```
74 changes: 1 addition & 73 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,76 +8,4 @@

# dev member experience

## Para executar em dev

### Requisitos

1. [pnpm](https://pnpm.io/installation) instalado
1. [docker](https://docs.docker.com/engine/install) instalado

### Configurações

Clone o projeto

```sh
git clone https://github.com/DeveloperParana/devmx
```

Configure a senha do banco e segredo jwt como quiser para uso local

```sh
mv .env-example .env
```

Preencha os valores para `DB_USER`, `DB_PASS`, `JWT_SECRET` e salve antes de executar o docker.

```sh
docker compose up -d
```

Instale as dependências

```sh
pnpm install
```

Execute o back-end e front-end

```sh
pnpm dev
```

## Para commits

Antes de escrever seu commit, execute lint, test e build dos projetos afetados pela sua alteração.

```sh
pnpm affected
```

Os commits podem ser feitos em português, mas use inglês para termos técnicos, não tente traduzi-los quando eles são conhecidos e usados em inglês.

```sh
pnpm cmt
```

Responda as perguntas para fazer o commit.

## Responsabilidades e relacionamentos

Trata-se de responsabilidade e relacionamentos, ou seja, qual a responsabilidade de cada camada e quais camadas podem depender diretamente uma das outras. Esta é uma convenção chamada [enforce module boundaries](https://nx.dev/features/enforce-module-boundaries#enforce-module-boundaries) e quem permite que as regras sejam aplicadas é o [nx](https://nx.dev).

A tabela a seguir representa a configuração no arquivo [`.eslintrc.json`](.eslintrc.json).

| | api | util | domain | data | ui | feature | resource | app |
| ---------: | :-: | :--: | :----: | :--: | :-: | :-----: | :------: | :-: |
| `api` | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `util` | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `domain` | ✓ | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `data` | ✓ | ✓ | ✓ | ✓ | 𝗫 | 𝗫 | 𝗫 | 𝗫 |
| `ui` | ✓ | ✓ | 𝗫 | 𝗫 | ✓ | 𝗫 | 𝗫 | 𝗫 |
| `feature` | ✓ | ✓ | 𝗫 | ✓ | ✓ | ✓ | 𝗫 | 𝗫 |
| `resource` | ✓ | ✓ | 𝗫 | ✓ | 𝗫 | 𝗫 | ✓ | 𝗫 |
| `app` | ✓ | ✓ | 𝗫 | ✓ | ✓ | ✓ | ✓ | 𝗫 |

Caso tenha interesse em aprofundar neste assunto e descobrir os motivos, recomendo que leia um conteúdo que escrevi ano passado, você pode fazer download através do link [Arquitetura em camadas, uma abordagem sobre responsabilidades e relacionamentos](https://conteudode.dev/pdf/nx).
Quer contribuir? Siga este guia 👉 [CONTRIBUTING](./CONTRIBUTING.md)
Loading