{"id":19339191,"url":"https://github.com/jhony2488/markdown-previewer","last_synced_at":"2026-05-09T05:06:07.180Z","repository":{"id":177990110,"uuid":"661211066","full_name":"jhony2488/markdown-previewer","owner":"jhony2488","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-02T06:20:51.000Z","size":160,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-06T10:48:09.460Z","etag":null,"topics":["cypress","javascript","react","react-hooks","reactjs","test","test-automation","testes-unitarios","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jhony2488.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-02T06:17:01.000Z","updated_at":"2023-07-03T16:41:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"6b85a4cf-9ee1-4853-b592-cd17109cb05f","html_url":"https://github.com/jhony2488/markdown-previewer","commit_stats":null,"previous_names":["jhony2488/markdown-previewer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhony2488%2Fmarkdown-previewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhony2488%2Fmarkdown-previewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhony2488%2Fmarkdown-previewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhony2488%2Fmarkdown-previewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhony2488","download_url":"https://codeload.github.com/jhony2488/markdown-previewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240442244,"owners_count":19801856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cypress","javascript","react","react-hooks","reactjs","test","test-automation","testes-unitarios","typescript"],"created_at":"2024-11-10T03:20:29.876Z","updated_at":"2026-05-09T05:06:07.135Z","avatar_url":"https://github.com/jhony2488.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\" id=\"\"\u003e\n   Markdown Previewer\n\u003c/h1\u003e\n\n\n\u003ch2 id=\"tabela-de-conteudo\"\u003eTabela de conteúdos\u003c/h2\u003e\n\u003c!--ts--\u003e\n   \n- [Sobre](#)\n\n- [Tabela de Conteudo](#tabela-de-conteudo)\n\n- [Features](#features)\n\n- [Como usar](#como-usar)\n\n  - [Pre Requisitos](#pré-requisitos)\n\n  - [Instalação](#instalação)\n\n  - [Rodando a aplicação](#-rodando-a-api)\n\n- [Storybook](#storybook)\n\n- [Testes](#-testes)\n\n- [Tecnologias](#-tecnologias)\n\n\n\u003c!--te--\u003e\n\n\u003ch2  id=\"features\"\u003e  \n  Features\n\u003c/h2\u003e\n\n- [x] Configurado style guide.\n- [x] Adicionado tipagens.\n- [x] Criado página para previewe de markdown.\n- [x] Criação de pagina de erro 404.\n- [x] Aplicação de documentação de componentes com storybook.\n- [x] Aplicado conteinerização com docker\n\n\u003ch2\u003eComo usar\u003c/h2\u003e\n\n\u003ch3\u003ePré-requisitos\u003c/h3\u003e\n\nAntes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:\n[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).\nAlém disto é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)\n\n\u003ch3 id=\"instalacao\"\u003eInstalação\u003c/h3\u003e\n\n```bash\n# Clone este repositório\n$ git clone \u003chttps://github.com/jhony2488/markdown-previewer\u003e\n# Acesse a pasta do projeto no terminal/cmd\n$ cd markdown-previewer\n# Instale as dependências\n$ npm install || yarn install\n```\n\n\u003ch3 id=\"rodando-api\"\u003e🎲 Rodando a aplicação sem docker\u003c/h3\u003e\n\n#### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado\n\n- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)\n\n```bash\n# Execute a aplicação em modo de desenvolvimento\n$ npm run dev || yarn dev\n# O servidor inciará na porta:5173 - acesse \u003chttp://localhost:5173\u003e\n```\n\n\u003ch3 id=\"rodando-api\"\u003e🎲 Rodando a aplicação com docker\u003c/h3\u003e\n\n#### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado\n\n- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)\n\n```bash\n# Execute a aplicação em modo de desenvolvimento\n$ docker compose up --build\n# O servidor inciará na porta:5173 - acesse \u003chttp://localhost:5173\u003e\n```\n\n\u003ch3 id=\"storybook\"\u003e🎲 Storybook\u003c/h3\u003e\n\n```bash\n# execute o storybook\n$ npm run storybook || yarn storybook\n# O servidor inciará na porta:6006 - acesse \u003chttp://localhost:6006/?path=#\u003e\n$ \n```\n\n\u003ch3 id=\"teste\"\u003e🎲 Testes Unitarios e de Integração com Jest\u003c/h3\u003e\n\n```bash\n# execute os testes com jest\n$ npm run test || yarn test\n```\n\n\u003ch3 id=\"teste\"\u003e🎲 Testes End to End com Cypress\u003c/h3\u003e\n\n```bash\n# Abra o cypress\n$ npm run cypress:open || yarn cypress:open\n# execute os testes do cypress\n$ npm run cypress:run || yarn cypress:run\n```\n\n\u003ch2 id=\"tecnologias\"\u003e🛠 Tecnologias\u003c/h2\u003e\n\nAs seguintes ferramentas foram usadas na construção do projeto:\n\n- [Node.js](https://nodejs.org/en/)\n- [React.js](https://pt-br.reactjs.org/)\n- [Vite](https://vitejs.dev/)\n- [Jest](https://jestjs.io/)\n- [Cypress](https://docs.cypress.io/guides/overview/why-cypress)\n- [Storybook](https://storybook.js.org/)\n- [Material UI](https://mui.com/)\n- [Eslint](https://eslint.org/)\n- [Prettier](https://prettier.io/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhony2488%2Fmarkdown-previewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhony2488%2Fmarkdown-previewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhony2488%2Fmarkdown-previewer/lists"}