https://github.com/jhony2488/desafio-flowdriver-front-end
https://github.com/jhony2488/desafio-flowdriver-front-end
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jhony2488/desafio-flowdriver-front-end
- Owner: jhony2488
- Created: 2023-05-27T16:09:27.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T19:46:55.000Z (almost 2 years ago)
- Last Synced: 2025-01-06T10:48:12.439Z (4 months ago)
- Language: TypeScript
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
App de estacionamento
Tabela de conteúdos
- [Sobre](#)
- [Tabela de Conteudo](#tabela-de-conteudo)
- [Features](#features)
- [Como usar](#como-usar)
- [Pre Requisitos](#pré-requisitos)
- [Instalação](#instalação)
- [Rodando a aplicação](#-rodando-a-api)
- [Storybook](#storybook)
- [Testes](#-testes)
- [Tecnologias](#-tecnologias)
Features
- [x] Configurado style guide.
- [x] Adicionado tipagens.
- [x] Criado listagem dos itens.
- [x] Fazer integração do CRUD com o back end
- [x] Criação de pagina de erro 404.
- [x] Aplicação de documentação de componentes com storybook.
- [x] Aplicado conteinerização com docker
Como usar
Pré-requisitos
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).
Além disto é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
Instalação
```bash
# Clone este repositório
$ git clone
# Acesse a pasta do projeto no terminal/cmd
$ cd desafio-flowdriver-front-end
# Instale as dependências
$ npm install || yarn install
```
🎲 Rodando a aplicação sem docker
#### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado
- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
```bash
# Execute a aplicação em modo de desenvolvimento
$ npm run start || yarn start
# O servidor inciará na porta:3000 - acesse
```
🎲 Rodando a aplicação com docker
#### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado
- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
```bash
# Execute a aplicação em modo de desenvolvimento
$ docker compose up --build
# O servidor inciará na porta:3000 - acesse
```
🎲 Storybook
```bash
# execute o storybook
$ npm run storybook || yarn storybook
# O servidor inciará na porta:6006 - acesse
$
```
🎲 Teste
```bash
# execute os testes com jest
$ npm run test-jest || yarn test-jest
# execute os testes com react-script
$ npm run test || yarn test
```
🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
- [Node.js](https://nodejs.org/en/)
- [React.js](https://pt-br.reactjs.org/)
- [Jest](https://jestjs.io/)
- [Storybook](https://storybook.js.org/)
- [Material UI](https://mui.com/)
- [Axios](https://www.axios.com/)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)