/notepad-api

A simple node.js / express CRUD API app.

Primary LanguageJavaScriptMIT LicenseMIT

Todo API

Getting Started

Prerequisites

Install Node and MongoDB. Clone repo.

Installing

Navigate to the directory and run npm install to download dependencies. Run npm run gen-docs . to generate public documentation for endpoints (available at /api/docs).

Rename config.json.example in the config directory to config.json and modify MONGODB_URI.

To start development environment run npm run dev.

Tests

Test environment can be launched with npm run test-watch.

Built With

  • Node.js - Environment
  • Express - Web Framework
  • JSDoc - Documentation Generator
  • Mocha - Test Framework
  • Expect - Assertion Library

Authors