- Configurado style guide.
- Adicionado tipagens.
- Criado página para previewe de markdown.
- Criação de pagina de erro 404.
- Aplicação de documentação de componentes com storybook.
- Aplicado conteinerização com docker
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode
# Clone este repositório
$ git clone <https://github.com/jhony2488/markdown-previewer>
# Acesse a pasta do projeto no terminal/cmd
$ cd markdown-previewer
# Instale as dependências
$ npm install || yarn install
# Execute a aplicação em modo de desenvolvimento
$ npm run dev || yarn dev
# O servidor inciará na porta:5173 - acesse <http://localhost:5173>
# Execute a aplicação em modo de desenvolvimento
$ docker compose up --build
# O servidor inciará na porta:5173 - acesse <http://localhost:5173>
# execute o storybook
$ npm run storybook || yarn storybook
# O servidor inciará na porta:6006 - acesse <http://localhost:6006/?path=#>
$
# execute os testes com jest
$ npm run test || yarn test
# Abra o cypress
$ npm run cypress:open || yarn cypress:open
# execute os testes do cypress
$ npm run cypress:run || yarn cypress:run
As seguintes ferramentas foram usadas na construção do projeto: