In-advance payment system for small organizations
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
migrations
seeds
src
test
.dockerignore
.editorconfig
.env-sample
.gitignore
.travis.yml
Dockerfile
LICENSE
README.md
docker-compose.yml
knexfile.ts
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

Piikki Logo

Build Status

Piikki is a pre-payment system for small societies such as university clubs and non-profit organizations. Its purpose is to replace the classic tab-paper-sheet taped on the fridge door and offer users an easy way to check off refreshments and keep book of their own tab saldo.

Piikki is designed to handle multiple user groups with one backend service. This allows users to have tab saldos in different groups and the possibility to use them all within one client application.

This github project only includes server backend and api of the Piikki pre-payment system.

Clients currently under development:

If you are interested of making your own Piikki client and use our hosted backend service, please contact the author to aquire your very own token!

API

API Definition

Postman collection

Development

  • Install node.js and Docker
  • Run npm install
  • Create local database with docker-compose up -d
  • Copy contents of .env-sample to new file called .env
  • Initialize database with npm run init-db
  • Run npm run dev to start the server

Acknowledgements

This project is a grateful recipient of the Futurice Open Source sponsorship program.