https://github.com/efefurkankarakaya/markdown-preview

Live Markdown Preview app built on Next.js with CI/CD configurations
https://github.com/efefurkankarakaya/markdown-preview

continuous-deployment continuous-integration nextjs react typescript

Last synced: about 2 months ago
JSON representation

Live Markdown Preview app built on Next.js with CI/CD configurations

• Host: GitHub
• URL: https://github.com/efefurkankarakaya/markdown-preview
• Owner: efefurkankarakaya
• Created: 2023-09-22T08:27:18.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-05T12:22:21.000Z (about 1 year ago)
• Last Synced: 2023-12-05T13:33:06.744Z (about 1 year ago)
• Topics: continuous-deployment, continuous-integration, nextjs, react, typescript
• Language: TypeScript
• Homepage: https://efefurkankarakaya.github.io/markdown-preview/
• Size: 413 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown Preview

A live Markdown Preview app built on Next.js

## Technologies

- [Next.js](https://nextjs.org/)

- [Remark](https://github.com/remarkjs/remark) - to process `Markdown` files

- [Rehype](https://github.com/rehypejs/rehype) - to process `HTML` files

- [Jest](https://jestjs.io/) - for `Unit Testing`

- [React Testing Library](https://testing-library.com/) - for `Component Testing`

- [Github Actions](https://docs.github.com/en/actions) - to manage `CI/CD`

- [Husky](https://typicode.github.io/husky/getting-started.html) - to manage `Git Hooks`

## Running

Step 1: Clone the repository. 


`$ git clone https://github.com/efefurkankarakaya/markdown-preview` 


Step 2: Change directory to the project folder. 


`$ cd markdown-preview` 


### Docker

Step 3: Create a docker image 


`$ docker build -t markdown-preview` 


Step 4: Run the docker image in a container 


`$ docker run -p 3000:3000 markdown-preview`

### pnpm

Step 3: Install dependencies 


`$ pnpm install` 


Step 4: Run the app 


`$ pnpm dev`

### yarn

Step 3: Install dependencies 


`$ yarn` 


Step 4: Run the app 


`$ yarn dev`

### npm

Step 3: Install dependencies 


`$ npm install` 


Step 4: Run the app 


`$ npm dev`