From d8eb51aa0cff30bbf4e969b79629a4a944df17b9 Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Wed, 7 Aug 2024 00:21:36 +0100 Subject: [PATCH] Add markdown note taking app idea --- src/data/projects/markdown-note-taking-app.md | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 src/data/projects/markdown-note-taking-app.md diff --git a/src/data/projects/markdown-note-taking-app.md b/src/data/projects/markdown-note-taking-app.md new file mode 100644 index 000000000..030c20b58 --- /dev/null +++ b/src/data/projects/markdown-note-taking-app.md @@ -0,0 +1,37 @@ +--- +title: 'Markdown Note-taking App' +description: 'Build a note-taking app that uses markdown for formatting.' +isNew: false +sort: 9 +difficulty: 'intermediate' +nature: 'API' +skills: + - 'Programming Language' + - 'Text Processing' + - 'Markdown libraries' + - 'File Uploads' +seo: + title: 'Markdown Note-taking App Project Idea' + description: 'Build an API for an expense tracker application.' + keywords: + - 'backend project idea' +roadmapIds: + - 'backend' +--- + +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. + +![Markdown Note-taking App](https://assets.roadmap.sh/guest/markdown-note-taking-app-tymi3.png) + +## 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.