Skip to content

Sumith-Kumar-Saini/Basic-Notes-Backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“˜ Basic Notes Backend

Live License: MIT

A simple backend API built with Express and TypeScript, offering basic CRUD operations to manage notes.


πŸš€ Live Demo

πŸ”— https://basic-notes-backend.onrender.com


πŸ“¦ Features

  • πŸ“„ GET /notes – Fetch all notes
  • πŸ“„ GET /note/:id – Fetch a specific note by ID
  • πŸ“ POST /notes – Create a new note
  • ✏️ PATCH /notes/:id – Update a note by ID
  • ❌ DELETE /notes/:id – Delete a note by ID

πŸ“‘ API Endpoints

Method Endpoint Description
GET /notes Fetch all notes
GET /notes/:id Fetch a note by ID
POST /notes Create a new note
PATCH /notes/:id Update a note by ID
DELETE /notes/:id Delete a note by ID

πŸ› οΈ Tech Stack

Tool Description
TypeScript Strongly typed JavaScript
Express Web framework for Node.js
Node.js JavaScript runtime
Nodemon Auto-restarting dev server
ts-node Run TypeScript files directly

βš™οΈ Installation & Setup

  1. Clone the repository:
git clone https://github.com/Sumith-Kumar-Saini/Basic-Notes-Backend.git
cd Basic-Notes-Backend
  1. Install dependencies:
npm install
  1. Build the TypeScript files:
npm run build
  1. Start the server in development mode (hot reload):
npm run dev

Or in production mode:

npm start

The server will be running at http://localhost:3000


πŸ“„ License

This project is licensed under the MIT License – see the LICENSE file for details.

About

πŸ“ A simple Express + TypeScript backend for managing notes with full CRUD support.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors