Skip to content

Commit 050fc01

Browse files
H4adH4ad
committed
feat(readme): added better style for readme
1 parent 0acf9e8 commit 050fc01

File tree

6 files changed

+169
-33
lines changed

6 files changed

+169
-33
lines changed

Diff for: ‎README.md

+47-27
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,55 @@
1-
# Omnistack 11
1+
<h1 align="center">
2+
<img alt="Be The Hero" src="./github/assets/logo.svg" width="400px" />
3+
</h1>
4+
5+
<h4 align="center">
6+
🚀 Semana OmniStack 11.0
7+
</h4>
8+
9+
<p align="center">
10+
<a href="#book-projeto">Projeto</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
11+
<a href="#rocket-tecnologias">Tecnologias</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
12+
<a href="#collision-diferenciais">Diferenciais</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
13+
<a href="#camera-imagens">Imagens</a>
14+
</p>
15+
216
![Backend NestJS](https://github.com/H4ad/omnistack/workflows/Backend%20NestJS/badge.svg)
317
[![Coverage Status](https://coveralls.io/repos/github/H4ad/omnistack/badge.svg?branch=master)](https://coveralls.io/github/H4ad/omnistack?branch=master)
418

5-
Esse é o repositório que contém todos os projetos da semana OmniStack 11.
19+
## :book:💻 Projeto
20+
21+
Be The Hero, seja o herói para quem precisa da sua ajuda!
22+
23+
O projeto foi pensado pelo time da :rocket: [Rocketseat](https://github.com/Rocketseat) para ajudar ONGs, dessa forma, cada ONG pode criar casos usando a aplicação web para possa ser divulgado para as pessoas.
24+
25+
Após criar um caso, as pessoas poderão usar o aplicativo para encontrar esses casos e serem os heróis para essa ONG.
26+
27+
## :rocket: Tecnologias
628

7-
Sobre o repositório, eu irei utilizar NestJS em vez de Express para o backend mas irei também adicionar a implementação em Express. O motivo da escolha de utilizar NestJS é porque eu prefiro programar com TypeScript, e ele é um excelente framework para criação de APIs com Node e TypeScript.
29+
Esse projeto foi desenvolvido com as seguintes tecnologias:
830

9-
## Entidades
31+
- Backend
32+
- [NestJS](https://nestjs.com/)
33+
- [Node.js](https://nodejs.org/en/)
34+
- Frontend
35+
- [React](https://reactjs.org)
36+
- Mobile
37+
- [React Native](https://facebook.github.io/react-native/)
38+
- [Expo](https://expo.io/)
39+
- [Ionic](https://ionicframework.com/)
40+
- [Angular](https://angular.io/)
1041

11-
A seguir, as entidades do banco de dados extraida a partir da primeira aula, eu irei modificar um pouco mas no geral é isso:
42+
## :collision: Diferenciais
1243

13-
Usuário:
14-
- Email
15-
- Password ( não havia também, mas eu irei trabalhar com sistema de autenticação por senha )
16-
- Roles ( não visto mas irei incluir por padrão )
17-
- Ongs[] ( uma relação OneToMany )
44+
Para o `mobile`, eu quis fazer uma comparação, então eu fiz em dois frameworks: React Native e em Ionic.
1845

19-
Apesar das Ongs aparentemente serem um usuário de certa forma, eu ainda irei separar em uma entidade por sí só.
46+
Para acessar cada projeto, veja [essa pasta](./mobile-ionic) para o Ionic, e [essa pasta](./mobile-react-native) para o React Native.
2047

21-
Ongs:
22-
- Name
23-
- Email
24-
- Cidade
25-
- UF
26-
- Whatsapp
27-
- Usuário ( uma relação ManyToOne )
28-
- Casos[] ( uma relação OneToMany )
48+
No `backend`, eu alterei um poucos as entidades para que suportassem autenticação JWT, assim como, a possibilidade de um usuário possuir várias ONGs, para saber mais, veja [o README](./backend-nestjs) do `backend`.
2949

30-
Incidentes:
31-
- Título
32-
- Descrição
33-
- Valor
34-
- Ong ( uma relação ManyToOne )
50+
Por consequência das alterações do `backend`, foram adicionados novas páginas para o `frontend` como o cadastro de usuários, de ONGs e a listagem delas.
3551

36-
## Imagens
52+
## :camera: Imagens
3753

3854
### Frontend
3955

@@ -69,11 +85,15 @@ A seguir, as páginas do aplicativo mobile.
6985

7086
#### Listagem de casos
7187

72-
![Página de listagem de casos](github/assets/list-incidents.jpg)
88+
<h1 align="center">
89+
<img alt="Página de listagem de casos" src="./github/assets/list-incidents.jpg" width="360px" />
90+
</h1>
7391

7492
#### Detalhes um caso
7593

76-
![Página de detalhes de um casos](github/assets/incident-detail.jpg)
94+
<h1 align="center">
95+
<img alt="Página de detalhes de um casos" src="./github/assets/incident-detail.jpg" width="360px" />
96+
</h1>
7797

7898
### Backend
7999

Diff for: ‎backend-nestjs/README.md

+45-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
# Backend OmniStack 11
1+
<h1 align="center">
2+
<img alt="Be The Hero" src="./../github/assets/logo.svg" width="400px" />
3+
</h1>
4+
5+
<h4 align="center">
6+
🚀 Semana OmniStack 11.0
7+
</h4>
8+
9+
<p align="center">
10+
<a href="#book-introducao">Introdução</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
11+
<a href="#memo-estrutura">Estrutura</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
12+
<a href="#notebook-typeorm">Typeorm</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
13+
<a href="#file-folder-entidades">Entidades</a>
14+
</p>
15+
16+
## :book: Introdução
217

318
Para esse OmniStack, em vez de utilizar Express, eu preferi usar NestJS no lugar por utilizar TypeScript.
419

5-
## Estrutura
20+
## :memo: Estrutura
621

722
As pastas seguem uma estrutura bem simples:
823
- src
@@ -13,7 +28,7 @@ As pastas seguem uma estrutura bem simples:
1328
- typeorm: Contém todos os arquivos relacionados ao `typeorm`.
1429
- utils: Contém todos os arquivos que contém funções úteis usadas em toda a aplicação.
1530

16-
## TypeOrm
31+
## :notebook: TypeOrm
1732

1833
Esse é o nome biblioteca que lida com o banco de dados, a estrutura desse cara é a seguinte:
1934

@@ -67,3 +82,30 @@ Caso queira realizar alguma operação mais complexa com o Typeorm, use o comand
6782
```shell
6883
npm run typeorm:cli COMANDO
6984
```
85+
86+
## :file_folder: Entidades
87+
88+
A seguir, as entidades do banco de dados extraida a partir da primeira aula, eu irei modificar um pouco mas no geral é isso:
89+
90+
Usuário:
91+
- Email
92+
- Password ( não havia também, mas eu irei trabalhar com sistema de autenticação por senha )
93+
- Roles ( não visto mas irei incluir por padrão )
94+
- Ongs[] ( uma relação OneToMany )
95+
96+
Apesar das Ongs aparentemente serem um usuário de certa forma, eu ainda irei separar em uma entidade por sí só.
97+
98+
Ongs:
99+
- Name
100+
- Email
101+
- Cidade
102+
- UF
103+
- Whatsapp
104+
- Usuário ( uma relação ManyToOne )
105+
- Casos[] ( uma relação OneToMany )
106+
107+
Incidentes:
108+
- Título
109+
- Descrição
110+
- Valor
111+
- Ong ( uma relação ManyToOne )

Diff for: ‎frontend-react/README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1-
# Frontend
1+
<h1 align="center">
2+
<img alt="Be The Hero" src="./../github/assets/logo.svg" width="400px" />
3+
</h1>
4+
5+
<h4 align="center">
6+
🚀 Semana OmniStack 11.0
7+
</h4>
8+
9+
<p align="center">
10+
<a href="#book-introducao">Introdução</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
11+
<a href="#bulb-diferencias">Diferenciais</a>
12+
</p>
13+
14+
## :book: Introdução
215

316
Essa será a implementação do Frontend em React.
417

5-
## Mudanças
18+
## :bulb: Diferenciais
619

720
Assim como eu modifiquei o `backend`, eu adicionei algumas coisas a mais no `frontend` para que eu conseguisse lidar com os dados enviados pela API. Dessa forma, há as seguintes páginas a mais:
821

Diff for: ‎github/assets/logo.svg

+20
Loading

Diff for: ‎mobile-ionic/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<h1 align="center">
2+
<img alt="Be The Hero" src="./../github/assets/logo.svg" width="400px" />
3+
</h1>
4+
5+
<h4 align="center">
6+
🚀 Semana OmniStack 11.0
7+
</h4>
8+
9+
<p align="center">
10+
<a href="#book-introducao">Introdução</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
11+
<a href="#memo-estrutura">Estrutura</a>
12+
</p>
13+
14+
## :book: Introdução
15+
16+
A seguir, você pode encontrar todo o código do projeto escrito em TypeScript com Angular e Ionic.
17+
18+
Para gerar o `build` dos arquivos nativos, foi utilizado o Capacitor, que é parecido com o Cordova mas a sua implementação é várias vezes mais tranquila de ser feita.
19+
20+
## :memo: Estrutura
21+
22+
As pastas seguem uma estrutura bem simples:
23+
- app
24+
- components: Contém os componentes que serão reutilizados em uma ou mais páginas.
25+
- factories: Contém as `factories` que basicamente são utilizadas para construir um `service` de forma mais flexivel.
26+
- interactors: Basicamente são serviços que possuem apenas a responsabilidade de lidar com a busca de dados da aplicação, seja via requisições HTTP ou cache.
27+
- models: Contém os `proxies` e também pode conter os `payloads` usados para representar dados que são enviados e recebidos da API.
28+
- pages: Contém todas as páginas da aplicação.
29+
- services: Contém todos os serviços que, diferente dos `ìnteractors`, possuem a responsabilidade de lida com a regra de negócio da aplicação.

Diff for: ‎mobile-react-native/README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
# Mobile
1+
<h1 align="center">
2+
<img alt="Be The Hero" src="./../github/assets/logo.svg" width="400px" />
3+
</h1>
4+
5+
<h4 align="center">
6+
🚀 Semana OmniStack 11.0
7+
</h4>
8+
9+
<p align="center">
10+
<a href="#book-introducao">Introdução</a>
11+
</p>
12+
13+
# :book: Introdução
214

315
Essa é a implementação da versão `mobile` feita em React Native.
416

0 commit comments

Comments
 (0)