zsoltime/react-markdown-previewer

React Markdown previewer for freeCodeCamp

React Markdown Previewer

This is my markdown previewer for Free Code Camp's first React challenge. Demo is available on my site.

User Stories

• I can type GitHub-flavored Markdown into a text area.
• I can see a preview of the output of my markdown that is updated as I type.

Tools Used

• React.js library
• Webpack module bundler
• Babel.js compiler
• ESLint linter with Airbnb's JS config
• Sass preprocessor with PostCSS' Autoprefixer
• Karma test runner
• Mocha test framework
• Expect assertion library
• Marked markdown parser and compiler

Install and Build

You need to have yarn installed on your computer, or you can use npm.

Clone this repo

git clone https://github.com/zsoltime/react-markdown-previewer.git
cd react-markdown-previewer

Install dependencies

yarn
# OR
npm install

Start dev server with hot reload

It builds HTML, CSS, and the JavaScript bundle, starts a dev server and refreshes the browser on every saved changes.

yarn start
# OR
npm start

Build production bundle

It builds production bundle, uglifies JS, minifies CSS - ready to upload.

yarn build
# OR
npm run build

Run unit tests

Run unit tests with Karma and Mocha

yarn test
# OR
npm run test