bitsmuggler / notes-example-app

NodeJS Notebook Example

notes-example-app

Playground to learn Node.js Basics & REST architecture paradigm

Parts

• Exemplary In-Memory note management as RESTful API (Branch: master)
• Persistent note management as RESTful API (Branch: mongodb)
• Web UI & RESTful API note management in VanillaJS (Branch: frontend-starter-vanillajs)

Prerequisites

1. Create a MongoDB Database with the name notes-example-app
2. Create a collection in the db with the name notebooks

Running Node.js Backend

1. Create a .env file with the connection string your MongoDB
   • Variable: MONGODB_CONNECTIONSTRING
2. Install dependencies npm install
3. Run server
   • npm run start or
   • Use nodemon: npx nodemon start
4. Access your API via: http://localhost:3000

Running Frontend

Only on branch: frontend-starter-vanillajs

1. Make sure your backend is running
2. Run the frontend webserver via gulp: npx gulp webserver
3. Access your frontend via Browser: http://localhost:8000