10BC0 GitHub - WBSCodingSchool/be-notes-app: Simple RESTful API for a WBS recap session
[go: up one dir, main page]

Skip to content

WBSCodingSchool/be-notes-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RESTful API for Notes App

Used during AI prompting recap for Gen AI integration

Setup

  • Fork repo
  • Clone into your computer
  • cd into working directory
  • npm i to install dependencies
  • create a .env file with a variable MONGO_URI with a value set to a valid Mongo URI, we suggest a free cluster on Mongo Atlas
  • The server defaults to port 8080, although an environment variable PORT can be used to override this behaviour

Commands

  • npm run dev: Starts development server, pulling environment variables from .env file
  • npm start: Production server, environment variables need to be passed to system.

Usage

  • The application has its entry point at index.js
  • There are 2 routes defined:
    • /entries
    • /notes
  • Each of the routes supports:
    • GET /<resource>: Get all
    • POST /<resource>: Create
    • GET /<resource>/:id: Get single
    • PUT /<resource>: Update single
    • DELETE /<resource>: Delete single

About

Simple RESTful API for a WBS recap session

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0