|
1 | | -# Fatorial |
| 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 | +# 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) |
| 13 | +- [Tecnologias usadas](#tecnologias) |
| 14 | +- [Resultados](#resultados) |
| 15 | +- [Como usar?](#comousar) |
| 16 | + |
| 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 | + |
| 26 | +<a id="tecnologias"></a> |
| 27 | +## :rocket: Tecnologias |
| 28 | +<p> |
| 29 | +Para o frontend desta aplicação utilizou-se das seguintes tecnologias: |
| 30 | +</p> |
| 31 | + |
| 32 | +- ReactJS |
| 33 | +- TypeScript |
| 34 | +- React Router Dom |
| 35 | +- React Icons |
| 36 | +- SASS |
| 37 | + |
| 38 | +<a id="resultados"></a> |
| 39 | +## :heavy_check_mark: Resultados |
| 40 | +<p> |
| 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 | +<iframe src="https://drive.google.com/file/d/1xHrablhJW5Jk2HBlKEkrrTGFNX5wgXO0/preview" width="640" height="480"></iframe> |
| 45 | +<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> |
| 46 | + |
| 47 | + |
| 48 | +<a id="comousar"></a> |
| 49 | +## :fire: Como executar? |
| 50 | +<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> |
| 51 | + |
| 52 | + |
| 53 | +### Baixando o frontend |
| 54 | +Clone este repositório |
| 55 | +```sh |
| 56 | +git clone https://github.com/higorpo/fatorial-frontend frontend |
| 57 | +``` |
| 58 | + |
| 59 | +Instale as dependências do projeto |
| 60 | +```sh |
| 61 | +cd frontend |
| 62 | +yarn |
| 63 | +``` |
| 64 | +### Baixando o backend |
| 65 | +Volte uma pasta utilizando ```cd ..``` e escolha um dos dois backends abaixo, siga as instruções |
| 66 | +#####Node.js |
| 67 | +Clone o repositório |
| 68 | +```sh |
| 69 | +git clone https://github.com/higorpo/fatorial-backend-node backend |
| 70 | +``` |
| 71 | + |
| 72 | +Instale as dependências do projeto |
| 73 | +```sh |
| 74 | +cd backend |
| 75 | +yarn |
| 76 | +``` |
| 77 | + |
| 78 | +Depois de executado o comando acima, execute ```cd ..``` |
| 79 | + |
| 80 | +--- |
| 81 | +#####Java |
| 82 | +Clone o repositório |
| 83 | +```sh |
| 84 | +git clone https://github.com/higorpo/fatorial-backend-java backend |
| 85 | +``` |
| 86 | + |
| 87 | +### Executando o backend |
| 88 | +Siga o tutorial do backend que você baixou acima (Node.js ou Java) |
| 89 | +#####Node.js |
| 90 | +```sh |
| 91 | +cd backend |
| 92 | +yarn dev |
| 93 | +``` |
| 94 | +Depois de executado o comando acima, execute ```cd ..``` |
| 95 | + |
| 96 | +--- |
| 97 | +#####Java |
| 98 | +```sh |
| 99 | +cd backend |
| 100 | +./gradlew bootRun |
| 101 | +``` |
| 102 | +Depois de executado o comando acima, execute ```cd ..``` |
| 103 | + |
| 104 | +### Configurando o frontend |
| 105 | +Antes de executarmos o frontend precisamos configurar a URL do nosso servidor, seja ele Node ou Java. |
| 106 | + |
| 107 | +Para isso entre na seguinte pasta: |
| 108 | +```sh |
| 109 | +cd ./frontend/src/config |
| 110 | +``` |
| 111 | +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. |
| 112 | + |
| 113 | +Para finalizar, volte para pasta inicial com |
| 114 | +```sh |
| 115 | +cd ../../../ |
| 116 | +``` |
| 117 | +### Executando o frontend |
| 118 | +Após ter completado o passo acima, inicie o servidor web |
| 119 | +```sh |
| 120 | +cd frontend |
| 121 | +yarn start |
| 122 | +``` |
| 123 | +Um servidor web deve começar a rodar na porta 3000, acesse-o usando ```http://localhost:3000``` |
0 commit comments