ContextQMD
Back to Developer Roadmap

Markdown Note-taking App

src/data/projects/markdown-note-taking-app.md

4.01.0 KB
Original Source

You are required to build a simple note-taking app that lets users upload markdown files, check the grammar, save the note, and render it in HTML. The goal of this project is to help you learn how to handle file uploads in a RESTful API, parse and render markdown files using libraries, and check the grammar of the notes.

Features

You have to implement the following features:

  • You’ll provide an endpoint to check the grammar of the note.
  • You’ll also provide an endpoint to save the note that can be passed in as Markdown text.
  • Provide an endpoint to list the saved notes (i.e. uploaded markdown files).
  • Return the HTML version of the Markdown note (rendered note) through another endpoint.

Tips to Get Started

Feel free to use any programming language and framework of your choice. Use the package manager of the chosen language to install the required libraries for parsing and rendering markdown files.