fire-notes

a simple WebSockets and REST api notes server to support the Github Note Taker app from the egghead.io course...

npm install -g foreman
npm install -g nodemon

npm install
sh demon

Features:

• simple notes api built on lowdb
• exposed ws api
• exposed REST api that supports CORS
• default response is JSON describing the server api

REST

- GET  /keys
- GET  /notes/:username
- POST /notes

Deployed:

the server has been deployed and is running here: fire-notes

{
  "wut": "a simple websocket & REST api notes server",
  "why": "wanted to build something like firebase",
  "who": "Richard Hess (aka. eswat2)",
  "app": "https://egghead-notes.herokuapp.com",
  "git": "https://github.com/eswat2/fire-notes",
  "wss": "wss://fire-notes.herokuapp.com",
  "api": [
    {
      "url": "/keys",
      "verb": "GET",
      "what": "list of keys"
    },
    {
      "url": "/notes",
      "verb": "POST",
      "what": "creates/updates a note container"
    },
    {
      "url": "/notes/:key",
      "verb": "GET",
      "what": "fetch note container for this key"
    },
    {
      "wss": {
        "request": [
          "GET",
          "KEYS",
          "POST"
        ],
        "response": [
          "DATA",
          "ping"
        ]
      }
    }
  ]
}

Reference:

• foreman
• nodemon