lcb01a / donatr

track and collect donations

donatr

track and collect donations

tl;dr run donatr

git clone https://github.com/derveloper/donatr.git
cd donatr/
sbt assembly
java -jar target/scala-2.12/donatr-assembly-0.1.0-SNAPSHOT.jar

then point your browser to http://localhost:8080.

demo

you can find a demo at https://donatr.herokuapp.com/

docker

Run the docker image from docker hub

docker run -i -d -p 8080:8080 -v /path/to/db/folder:/data --name donatr vileda/donatr2

You can also use docker to build an image, it will install all requirements

./docker-build.sh
docker run -i -d -p 8080:8080 -v /path/to/db/folder:/data --name donatr vileda/donatr2

migrate from donatr v1

to migrate from donatr v1, see code in donatr-migration

who should use it?

the intended purpose of this is to run at hackerspaces that want to collect donations for the space infrastructure. but it is not tied to any hackerspace. anyone who wants to collect donations could use it.

collect donations

create accounts and donatables. accounts then transfer money to donatables. accounts have a balance where the money is withdrawn from. deposits are made of negative amount donatables. one could use it like a prepaid system.

track donations

donatr is written using a eventsourced pattern. every action in the system is tracked by events.

technologies used

the backend is implemented in scala using a CQRS/ES pattern. the frontend is implemented using monadic-html using reactive patterns. default database is h2, but every database supported by slick should work

development

start hacking with your favorite editor or IDE!

backend

the backend is a scala sbt project located in donatr-core/src/ and http2-server/src/.

frontend

the frontend client is located in donatr-ui. since its built in scala.js you only need sbt.

roadmap

• implement caching
• donate multiple times with one click
• add legacy mete api for app compatibility

license

Copyright 2017 derveloper

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.