Markdown Previewer

Tabela de conteúdos

• Sobre

• Tabela de Conteudo

• Features

• Como usar

  • Pre Requisitos

  • Instalação

  • Rodando a aplicação

• Storybook

• Testes

• Tecnologias

Features

• 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

Como usar

Pré-requisitos

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

Instalação

# 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

🎲 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/

# Execute a aplicação em modo de desenvolvimento
$ npm run dev || yarn dev
# O servidor inciará na porta:5173 - acesse <http://localhost:5173>

🎲 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/

# Execute a aplicação em modo de desenvolvimento
$ docker compose up --build
# O servidor inciará na porta:5173 - acesse <http://localhost:5173>

🎲 Storybook

# execute o storybook
$ npm run storybook || yarn storybook
# O servidor inciará na porta:6006 - acesse <http://localhost:6006/?path=#>
$ 

🎲 Testes Unitarios e de Integração com Jest

# execute os testes com jest
$ npm run test || yarn test

🎲 Testes End to End com Cypress

# Abra o cypress
$ npm run cypress:open || yarn cypress:open
# execute os testes do cypress
$ npm run cypress:run || yarn cypress:run

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• React.js
• Vite
• Jest
• Cypress
• Storybook
• Material UI
• Eslint
• Prettier