docs(reademe): atualiza Readme com detalhes do projeto

This commit is contained in:
Manuela Luana Schumacker Tavares 2023-01-19 16:43:19 -03:00
parent 910f5bc99c
commit 00b7c5ac2e

View File

@ -2,12 +2,22 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## About
This project is an institutional page, with a mobile sidebar 'menu
hamburger', contact form with formik, accordion menu in the footer, input validation using yup and route navigation with no need to reload the page!
Este Projeto é uma página institucional, com 'menu hamburguer' mobile, formulário de contato com formik, menu acordeon no footer, validação de inputs utilizando yup e navegação por rotas sem necessidade de reload da página!
## Available Scripts
In the project directory, you can run:
### `npm start`
Rode o projeto no modo de desenvolvimento. \
Abra [http://localhost:3000](http://localhost:3000) para ve-lo no navegador.
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
@ -44,3 +54,19 @@ You dont have to ever use `eject`. The curated feature set is suitable for sm
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
## Libraries that I used
React
react-dom
react-router-dom
typescript
sass
react-headless-accordion
Classnames
Formik
Yup
## Node version
node: ^16.18.11