~igemnace/notes-api

A REST API for the perennial TodoMVC, for education and demonstration purposes.

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~igemnace/notes-api
read/write
git@git.sr.ht:~igemnace/notes-api

You can also use your local clone with git send-email.

#notes-api

A simple REST API for notes, built in Feathers.

#About

This project uses Feathers. An open source web framework for building modern real-time applications.

#Getting Started

Getting up and running is as easy as 1, 2, 3.

  1. Make sure you have NodeJS and npm installed.

  2. Install your dependencies

    cd path/to/notes-api
    npm install
    
  3. Start your app

    npm start
    

#Testing

Simply run npm test and all your tests in the test/ directory will be run.

#Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers help                           # Show all commands

#Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.