Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

📝 Markdown Note Taking App

A simple C# .NET API‑driven app for uploading and displaying markdown notes.
This project is part of the C# Developer Roadmap by roadmap.sh:

🔗 Markdown Note Taking App – roadmap.sh

🚀 Features

  • Create, upload, and list markdown notes.
  • View notes rendered in a simple web UI.
  • Lightweight API backend built with ASP.NET Core (C#).

🧩 Grammar check endpoint (stub)

  • The API exposes a grammar‑checking endpoint at /api/grammar/check.
  • For now this is a stub that always returns HTTP 200 OK with a message like "grammar ok".
  • Actual grammar‑checking logic is intentionally omitted so the app remains fully self‑contained and easy to run without external accounts or services.

🛠️ Tech stack

  • Backend: ASP.NET Core (C#), Minimal APIs or controllers.
  • Frontend: Basic HTML/CSS/JavaScript (or your own UI).
  • Storage: File‑based storage or in‑memory (you choose).

📦 How to run (for a recruiter)

  1. Clone the repo:

    git clone https://github.com/jakubszubka/MarkdownNoteTakingAPI.git
    cd markdown-notes-app
  2. Restore and run:

    dotnet restore
    dotnet run
  3. Open the app in your browser (default: http://localhost:5000 or as shown in the console).

  4. The grammar‑check endpoint is reachable at:

    POST /api/grammar/check
    Body: { "text": "any markdown text" }
    → Returns 200 OK, message: "grammar ok"

No external API keys, cloud accounts, or Docker are required to run the project.

🎯 Goal

This project demonstrates:

  • Building a CRUD‑style API in C# .NET.
  • Handling file‑based or in‑memory data persistence.
  • Designing clean HTTP endpoints for future extensibility (e.g., adding real grammar checking later).

Thanks for checking the project! 🚀

About

A simple C# .NET API‑driven app for uploading and displaying markdown notes.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages