Skip to content

Commit 790fe8e

Browse files
committed
📝 Update README
1 parent 2a268fc commit 790fe8e

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

.github/logo.png

2.26 KB
Loading

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
<h3 align="center">
2+
<img src=".github/logo.png" alt="Fatorial Logo"/>
3+
<br/>
4+
<span>
5+
Faça seus cálculos de fatorial de maneira simples e rápida.
6+
</span>
7+
</h3>
8+
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+
14+
# Indice
15+
- [Tecnologias usadas](#tecnologias)
16+
- [Resultados](#resultados)
17+
- [Como usar?](#comousar)
18+
19+
<a id="tecnologias"></a>
20+
## :rocket: Tecnologias
21+
<p>
22+
Para o frontend desta aplicação utilizou-se das seguintes tecnologias:
23+
</p>
24+
25+
- TypeScript
26+
- Express
27+
- Express Validator
28+
29+
<a id="resultados"></a>
30+
## :heavy_check_mark: Resultados
31+
<p>
32+
Faça uma requisição ao backend em Node.js a partir do seguinte comando:
33+
34+
```sh
35+
curl https://fatorial.herokuapp.com/factorial?number=100
36+
```
37+
38+
<a id="comousar"></a>
39+
## :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>
41+
42+
Clone o repositório
43+
```sh
44+
git clone https://github.com/higorpo/fatorial-backend-node backend
45+
```
46+
47+
Instale as dependências do projeto
48+
```sh
49+
cd backend
50+
yarn
51+
```
52+
53+
Execute o servidor usando
54+
55+
```sh
56+
yarn dev
57+
```
58+
59+
Após executar o comando acima, um servidor deve começar a rodar na porta 8000.

0 commit comments

Comments
 (0)