Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhony2488/markdown-previewer
https://github.com/jhony2488/markdown-previewer
cypress javascript react react-hooks reactjs test test-automation testes-unitarios typescript
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jhony2488/markdown-previewer
- Owner: jhony2488
- License: mit
- Created: 2023-07-02T06:17:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-02T06:20:51.000Z (over 1 year ago)
- Last Synced: 2024-11-10T03:21:56.659Z (about 2 months ago)
- Topics: cypress, javascript, react, react-hooks, reactjs, test, test-automation, testes-unitarios, typescript
- Language: TypeScript
- Homepage:
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Markdown Previewer
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 página para previewe de markdown.
- [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 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/](https://nodejs.org/en/download/)
```bash
# Execute a aplicação em modo de desenvolvimento
$ npm run dev || yarn dev
# O servidor inciará na porta:5173 - 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:5173 - acesse
```
🎲 Storybook
```bash
# execute o storybook
$ npm run storybook || yarn storybook
# O servidor inciará na porta:6006 - acesse
$
```
🎲 Testes Unitarios e de Integração com Jest
```bash
# execute os testes com jest
$ npm run test || yarn test
```
🎲 Testes End to End com Cypress
```bash
# 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](https://nodejs.org/en/)
- [React.js](https://pt-br.reactjs.org/)
- [Vite](https://vitejs.dev/)
- [Jest](https://jestjs.io/)
- [Cypress](https://docs.cypress.io/guides/overview/why-cypress)
- [Storybook](https://storybook.js.org/)
- [Material UI](https://mui.com/)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)