Skip to content

Commit 178322d

Browse files
committed
📝 Update README
1 parent 137aa8a commit 178322d

File tree

1 file changed

+82
-14
lines changed

1 file changed

+82
-14
lines changed

README.md

Lines changed: 82 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,68 @@
66
</span>
77
</h3>
88

9-
<br/>
10-
<br/>
11-
<br/>
12-
<a href="https://github.com/higorpo/fatorial-frontend">Veja o repositório principal desta aplicação.</a>
13-
149
# Indice
10+
- [Sobre](#sobre)
11+
- [Repositório do backend em Node.js](https://github.com/higorpo/fatorial-backend-node)
12+
- [Repositório do backend em Java](https://github.com/higorpo/fatorial-backend-java)
1513
- [Tecnologias usadas](#tecnologias)
1614
- [Resultados](#resultados)
1715
- [Como usar?](#comousar)
1816

17+
<a id="sobre"></a>
18+
## :bookmark: Sobre
19+
<p>
20+
Esta aplicação foi criada com base no desafio proposto no processo seletivo do <a href="http://bridge.ufsc.br/" target="_blank">Laboratório Bridge</a>. A ideia era criar uma interface web que pudesse ser usada para desenvolver cálculos fatoriais usando um backend.
21+
</p>
22+
<p>
23+
O frontend desta aplicação foi desenvolvido utilizando React.js com TypeScript e SASS. Já o backend possuí duas versões: uma feita em <a href="https://github.com/higorpo/fatorial-backend-node"><strong>Node.js</strong></a> com Express e outra feita em <a href="https://github.com/higorpo/fatorial-backend-java"><strong>Java</strong></a> utilizando o framework Spring. Isto foi feito devido a minha maior proximidade com o universo JavaScript, neste caso, com o Node.js quando comparado com o Java.
24+
</p>
25+
1926
<a id="tecnologias"></a>
2027
## :rocket: Tecnologias
2128
<p>
2229
Para o frontend desta aplicação utilizou-se das seguintes tecnologias:
2330
</p>
2431

32+
- ReactJS
2533
- TypeScript
26-
- Express
27-
- Express Validator
34+
- React Router Dom
35+
- React Icons
36+
- SASS
2837

2938
<a id="resultados"></a>
3039
## :heavy_check_mark: Resultados
3140
<p>
32-
Faça uma requisição ao backend em Node.js a partir do seguinte comando:
41+
O site foi construído com base na minha prototipagem no Figma, que pode ser conferida <a href="" target="_blank">clicando aqui</a>.
42+
</p>
43+
<p>Do desenvolvimento desse, chegou-se ao seguinte resultado:</p>
44+
45+
Clique na foto abaixo para ver o vídeo de demonstração do site:
46+
[![Assista ao video](https://lh6.googleusercontent.com/Q5lMf3oBeZ6QT5qX3Z4z9uYr5VgMcI8GMYY8Kh44N0Kz1QqLSG0l7-AYBqYNHwWj2N20BxLU-q6k0RAGJJwK=w1280-h720-k-rw-pd)](https://drive.google.com/file/d/1xHrablhJW5Jk2HBlKEkrrTGFNX5wgXO0/view)
47+
48+
49+
<p>Você pode testar a aplicação agora mesmo através <a href="https://fatorial.vercel.app/" target="_blank">deste link</a>, uma versão do site hospedada na <b>Vercel</b>.</p>
3350

34-
```sh
35-
curl https://fatorial.herokuapp.com/factorial?number=100
36-
```
3751

3852
<a id="comousar"></a>
3953
## :fire: Como executar?
40-
<p>Para executar este projeto em sua máquina local existem alguns requisitos básicos. Você deve ter o Node.js instalado na sua versão mais recente e um gerenciador de pacotes Yarn ou NPM.</p>
54+
<p>Para executar este projeto em sua máquina local existem alguns requisitos básicos. Você deve ter o Node.js instalado na sua versão mais recente e um gerenciador de pacotes Yarn ou NPM, além disso, se for utilizar o Java como backend precisa ter todas as dependências instaladas (Java 11).</p>
55+
4156

57+
### Baixando o frontend
58+
Clone este repositório
59+
```sh
60+
git clone https://github.com/higorpo/fatorial-frontend frontend
61+
```
62+
63+
Instale as dependências do projeto
64+
```sh
65+
cd frontend
66+
yarn
67+
```
68+
### Baixando o backend
69+
Volte uma pasta utilizando ```cd ..``` e escolha um dos dois backends abaixo, siga as instruções
70+
#####Node.js
4271
Clone o repositório
4372
```sh
4473
git clone https://github.com/higorpo/fatorial-backend-node backend
@@ -50,10 +79,49 @@ cd backend
5079
yarn
5180
```
5281

53-
Execute o servidor usando
82+
Depois de executado o comando acima, execute ```cd ..```
83+
84+
---
85+
#####Java
86+
Clone o repositório
87+
```sh
88+
git clone https://github.com/higorpo/fatorial-backend-java backend
89+
```
5490

91+
### Executando o backend
92+
Siga o tutorial do backend que você baixou acima (Node.js ou Java)
93+
#####Node.js
5594
```sh
95+
cd backend
5696
yarn dev
5797
```
98+
Depois de executado o comando acima, execute ```cd ..```
99+
100+
---
101+
#####Java
102+
```sh
103+
cd backend
104+
./gradlew bootRun
105+
```
106+
Depois de executado o comando acima, execute ```cd ..```
107+
108+
### Configurando o frontend
109+
Antes de executarmos o frontend precisamos configurar a URL do nosso servidor, seja ele Node ou Java.
110+
111+
Para isso entre na seguinte pasta:
112+
```sh
113+
cd ./frontend/src/config
114+
```
115+
Edite o arquivo ```api.ts``` colocando a URL do seu backend (normalmente ```http://localhost:8000```). Se você não fizer isto você estará rodando com o um backend Node.js previamente hospedado no Heroku.
58116

59-
Após executar o comando acima, um servidor deve começar a rodar na porta 8000.
117+
Para finalizar, volte para pasta inicial com
118+
```sh
119+
cd ../../../
120+
```
121+
### Executando o frontend
122+
Após ter completado o passo acima, inicie o servidor web
123+
```sh
124+
cd frontend
125+
yarn start
126+
```
127+
Um servidor web deve começar a rodar na porta 3000, acesse-o usando ```http://localhost:3000```

0 commit comments

Comments
 (0)