NAJU-Adebar

Management tool used by the NAJU Sachsen to keep track of volunteers and the like. Currently under heavy development and in pre-alpha state.

Note	a german version of this readme will also be created

Quickstart

To get things running you will need

• the Java Development Kit, Version 8 - either from Oracle or as OpenJDK

• Maven 3.x

• preferably an installation of Git

Kick off the application like the following:

$ git clone https://github.com/portux/NAJU-Adebar.git
$ cd NAJU-Adebar
$ mvn clean package
$ mvn spring-boot:run

Now Adebar should be hosted on a new local Tomcat-instance. You should be able to connect to it through your favourite webbrowser at http://localhost:8080.

What to expect

Adebar tries to keep track of volunteers, events, projects, newsletters and the like. Activists should be able to easily collect and maintain the data they need to organise the events and campaigns they host. This includes the management of participants and subscribers to newsletters as well as the management of local chapters. To make the application as widely accessable as possible, all content is served through web forms. Find more info and help about Adebar on the wiki pages.

Technical details

Adebar is implemented in Java, using varios tools from the Spring Framework. The UI is created using Thymeleaf. A detailed (javadoc) documentation will likely be available through the wiki one day. The general design of the application will also be discussed there. I tried to make this as transparent as possible and explain what led to which decision as best as I could. So if you’re interested in Adebar’s backbones - just check it out.

FAQ, troubleshooting

Maybe you will find some useful information below..

"Your Quickstart guide doesn’t work for me"

There may be multiple reasons for this. As Adebar is a work-in-progress and still in a pretty early stage, the current build may simply be broken. However I perform some integration (and unit) testing before each commit to prevent this as best as possible. If you aren’t even able to build the application, you should check your setup. Your console output should look like this:

$ java -version
openjdk version "1.8.0_91"
OpenJDK Runtime Environment (build 1.8.0_91-8u91-b14-3ubuntu1~16.04.1-b14)
OpenJDK 64-Bit Server VM (build 25.91-b14, mixed mode)
$ mvn -v
Apache Maven 3.3.9
Maven home: /usr/share/maven
Java version: 1.8.0_91, vendor: Oracle Corporation
Java home: /usr/lib/jvm/java-8-openjdk-amd64/jre
Default locale: de_DE, platform encoding: UTF-8
OS name: "linux", version: "4.4.0-38-generic", arch: "amd64", family: "unix"
$ git --version
git version 2.7.4

Of course operating system and the like may vary.

"I found a bug, what next?"

Feel free to contact me about new bugs, or open an issue yourself. But please check out the issue tracker before, maybe the problem was already reported there.

"This feature would also be great…​"

I generally appreciate any proposals. Depending on my resources and on how useful me or the NAJU things the idea would be, implementation could however take some time. If you’re feeling familiar with the technology stack Adebar is build upon, you could also write it yourself and make a pull request :-)