A tool to manage the calendar of the Fachschaft Mathe/Physik Uni Regensburg
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system (Raspberry Pi).
Either DMD or LDC is needed to compile the project. Additionally, the package manager DUB is needed. Install via your distribution’s package manager if you are running linux or via Homebrew if you are running OS X:
- Debian based systems:
sudo wget http://master.dl.sourceforge.net/project/d-apt/files/d-apt.list -O /etc/apt/sources.list.d/d-apt.list
sudo apt-get update && sudo apt-get -y --allow-unauthenticated install --reinstall d-apt-keyring
sudo apt-get update
# DMD:
sudo apt-get install dmd-compiler
# LDC:
sudo apt-get install ldc
# DUB:
sudo apt-get install dub
- Arch Linux:
# DMD:
sudo pacman -S dmd
# LDC:
sudo pacman -S ldc
# DUB:
sudo pacman -S dub
- OS X
# DMD:
brew install dmd
# LDC:
brew install ldc
# DUB:
brew install dub
Access to a MySQL (or its open source fork MariaDB) or a MongoDB server is needed. To install it locally, use your distribution’s package manager if you are running linux or Homebrew if you are running OS X:
- Debian based systems:
# MariaDB:
sudo apt-get install mariadb
# MongoDB:
sudo apt-get install mongodb-org
- Arch Linux:
# MariaDB:
sudo pacman -S maraidb
# MongoDB:
sudo pacman -S mongodb
- OS X
# MariaDB:
brew install mariadb
# Mongo:
brew install mongodb
The project depens on OpenSSL being available. Both OpenSSL-1.0 and OpenSSL-1.1 are supported, but in order to successfully use OpenSSL-1.0, the switch --override-config vibe-d:tls/openssl needs to be added to all dub commands.
OpenSSL should be available by default on most systems. If it is not available, use your distribution’s package manager to install it if you are running linux, or Homebrew if you are running OS X:
- Debian based systems:
sudo apt-get install openssl
- Arch Linux:
sudo pacman -S openssl
- OS X
brew install openssl
To install the project, you first need to clone the repository:
git clone https://github.com/fsimphy/fsical-management.git
Building the project is done by running the following command inside the project’s root directory:
dub build
To run the project, first make sure that the MySQL or MongoDB server is running. Then set up the database by running the following commands inside the project’s root directory:
mysql -h <host> -u root -p < schema.sql
mongo <host>/FsicalManagement
> db.users.insert({ "username": "foo", "passwordHash": "$5$ZcsLcID1hIeYDr7ItwSJPdOOUP0FpXYXiHXs4O5XJI0=$/XWInm91lu1dMAi3dMSZSIJ+2hwZgrBF79rMuNc35Rc=", "privilege": NumberInt(2), "_id": "5988ef4ae6c19089a1a53b79" })
This will create a database called FsicalManagement and the necessary tables. If you want to use a different database name, an already existing database or a different username, you need to adjust the above commands and / or the schema.sql file accordingly.
This also adds a default user named foo with password bar.
To actually run the project, simply run the following command in the project’s root directory:
dub run [-- options]
If you already built the project, you can also run it directly:
./generated/fsical-management [options]
See configuration for a list of available options.
The project can be configured either by command-line switches or via an optional configuration file. These are the available options:
Usage: fsical-management <options>
-h --help Prints this help screen.
-v --verbose Enables diagnostic messages (verbosity level 1).
--vv, --vverbose Enables debugging output (verbosity level 2).
--vvv Enables high frequency debugging output (verbosity level
3).
--vvvv Enables high frequency trace output (verbosity level 4).
--uid=<value>, --user=<value>
Sets the user name or id used for
privilege lowering.
--gid=<value>, --group=<value>
Sets the group name or id used for
privilege lowering.
-d <value>, --disthost=<value>
Sets the name of a vibedist server to
use for load balancing.
--distport=<value>
Sets the port used for load
balancing.
--database=<value>
The database system to use.
--mongodb.host=<value>
The host of the MongoDB instance to
use.
--mongodb.database=<value>
The name of the MongoDB database to
use.
--mysql.host=<value>
The host of the MySQL instance to
use.
--mysql.username=<value>
The username to use for logging into
the MySQL instance.
--mysql.password=<value>
The password to use for logging into
the MySQL instance.
--mysql.database=<value>
The name of the MySQL database to
use.
The optional configuration file (vibe.conf) is a JSON file, containing an object with the keys corresponding to option names, and values corresponding to their values. It is searched for in the local directory, the user’s home directory, or /etc/vibe/, whichever is found first. Here is an example of a vibe.conf file resulting in the default configuration:
{
"database": 0,
"mongodb": {
"host": "localhost",
"database": "FsicalManagement",
},
"mysql": {
"host": "localhost",
"username": "username",
"password": "password",
"database": "FsicalManagement",
},
}Unfortunately, vibe.d does not yet support using the names of enums in configuration files, so until this is fixed, we need to write numbers. 0 corresponds to mongodb, 1 corresponds to mysql.
To run the tests, run the following command in the project’s root directory:
dub test
This runs all available tests. To run only a specific test, run the following command in the project’s root directory:
dub test -- <fully qualified name of the test module>.<test name>
See unit-threaded for more information on available testing options.
Deploying the project on a Raspberry Pi requires some more work, because DMD is not able to build arm binaries and LDC is not available in the repositories of the major linux distributions for the Raspberry Pi.
We suggest using Arch Linux ARM, but using a different distribution such as Raspbian should also be possible.
First install necessary dependencies:
sudo pacman -S llvm gcc ncurses zlib
We will install LDC-1.6.0, which depends on libtinfo. It is contained in the ncurses package, but the version (libtinfo.so.6.0) is wrong (LDC needs libtinfo.so.5). It seems as though simply creating a symbolic link does the trick:
sudo ln -s /usr/lib/libtinfo.so /usr/lib/libtinfo.so.5
Be aware that this is quite hacky and might cause problems later on. It might be better to install libtinfo.so.5 manually.
To install LDC-1.6.0 (and DUB), download and extract it in your home folder via the following commands:
wget https://github.com/ldc-developers/ldc/releases/download/v1.6.0/ldc2-1.6.0-linux-armhf.tar.xz
tar xf ldc2-1.6.0-linux-armhf.tar.xz
Then add it to your PATH:
export PATH=~/ldc2-1.6.0-linux-armhf/bin
You might want to add the previous command to your .bashrc (or similar) file so you don't have to retype it every time you want to use DUB or LDC.
Now you can build, run and test the project as explained in the earlier sections.
- DUB - Dependency Management
- Poodinis - Dependency Injection Framework
- unit-threaded - Testing Framework
- vibe.d - Web Framework
Please read CONTRIBUTING.md for details on the process for submitting issues and pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the MIT License, see the LICENSE.md file for details.
Thanks a lot to the folks at the D Programming Language Forum and especially to Sönke Ludwig, the maintainer of vibe.d, for always helping out with technical questions.