Overview

A personal inventory app. useful for keeping track of your stuff, and who you loaned it to.

Prerequisites

• PostgreSQL
• Node

Stack

• Koa
• sequelize
• Vue
• Vuex
• Webpack

Startup

1. Look in the db.config.js and either make a postgres db with those params, or change that file to suit your db
2. Add SSL certificates (the openssl command is in the ssl folder)
3. npm install (a postinstall command runs after this that sets up the tables)
4. npm run local (Starts the app with supervisor, which will reload js files when they’re edited)
5. npm run dev (watches web app files and rebuilds them).
6. npm run test to test the API. App must be running first

API

Current api url is api/v1

There are three endpoints:

• category : categorizaton of items
• user : users
• item : items that a user owns

All three APIs are identical in structure and usage. In the API below, replace category with the singular/plural of the other two endpoints, and you’re good to go.

category | POST | requires a JSON body. will create that category and return the created version
/category | GET | Returns array of all categories (needs to be deprecated) |
/category/:id | GET | Returns category of that id |
/categories | GET | Returns array of categories |
/categories?field=value | GET | returns array of all matches. Search by any field and value. Exact matches, though.
/category:id | PUT | needs a JSON body, returns updated category
/category/:id | DELETE | Deletes that category. Returns state