https://github.com/yiipu/checkdown

Checkdown is a simple markdown previewer that allows you to work on a checklist with your team in real-time.
https://github.com/yiipu/checkdown

mdx nextjs socket-io

Last synced: 3 months ago
JSON representation

Checkdown is a simple markdown previewer that allows you to work on a checklist with your team in real-time.

• Host: GitHub
• URL: https://github.com/yiipu/checkdown
• Owner: Yiipu
• License: mit
• Created: 2024-05-31T13:52:40.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-08T12:35:30.000Z (4 months ago)
• Last Synced: 2024-10-14T03:42:20.854Z (3 months ago)
• Topics: mdx, nextjs, socket-io
• Language: JavaScript
• Homepage: https://checkdown.azurewebsites.net
• Size: 1.02 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


real-time checklist workspace















  中文 | English



## Features

- User & Resource

  - [x] File Management

  - [x] Login with GitHub or Email

- Custom MDX Rendering

  - [x] Interactive Checkboxes

- Workspace

  - [x] Invitation Codes

  - [x] Checkbox Blame

  - [x] Real-time Checkbox State Updates

- Marketplace

  - [x] File Summarization

## Technology Stack

Source Code

| Tech | For |

|---|---|

| [![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)](https://nextjs.org/) | Full-stack framework |

| [![MDX](https://img.shields.io/badge/MDX-black?style=for-the-badge&logo=mdx)](https://mdxjs.com/) | Custom markdown rendering |

| [![Socket.io](https://img.shields.io/badge/Socket.io-black?style=for-the-badge&logo=socket.io&badgeColor=010101)](https://socket.io/) | Real-time bidirectional communication |

| [![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) | Styling and design |

| [![MySQL](https://img.shields.io/badge/mysql-4479A1.svg?style=for-the-badge&logo=mysql&logoColor=white)](https://www.mysql.com/) | Database |

| [![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)](https://react.dev/) | Underlying Tech of Next.js |

| [![Azure](https://img.shields.io/badge/azure-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://azure.com) | Language API |

CI & CD

| Tech  |  For |

| --- | --- |

| [![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)](https:/docker.com/) | Containerization and deployment |

| [![Azure](https://img.shields.io/badge/azure-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://azure.com) | Hosting services |

| [![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)](https://docs.github.com/actions) | Automation of CI/CD processes |

## Self-hosting & Development

Please refer to the [document branch](https://github.com/Yiipu/Checkdown/tree/documents) for more information.

## Resources Used for Sample

Thanks to these repositories for providing the checklist samples:

- [Front End Checklist](https://github.com/thedaviddias/Front-End-Checklist)

- [Frontend Checklist for Websites](https://github.com/drublic/checklist)

- [Designing iOS architecture Checklist](https://github.com/BohdanOrlov/architecture-checklist)

- [API security checklist](https://github.com/shieldfy/API-Security-Checklist)