ninetofiver (or 925r) is a free and open source time and leave tracking application.

Create and activate a virtual environment:

python3 -m virtualenv -p python3 ninetofiver_venv
source ninetofiver_venv/bin/activate

Install build dependencies:

apt-get install -y python-dev libldap2-dev libsasl2-dev libssl-dev

Install the application:

python setup.py install
pip install -r requirements.txt

1. Run python manage.py migrate to create the models.

2. Run python manage.py createsuperuser to create an admin user

Running the command below starts linked docker containers running OpenLDAP and ninetofiver at http://127.0.0.1:8888. You may need to install docker and docker-compose first.

Note: Running this application using Docker should only be done when developing locally, if at all.

docker-compose -f ./scripts/docker/docker-compose.yml up

Running the command below starts a development server at http://127.0.0.1:8000.

python manage.py runserver

Running the command below starts a server using the production configuration at http://127.0.0.1:8000.

Note: The insecure flag is used to allow the server to serve static files.

python manage.py runserver --configuration=Prod --insecure

Since this application is built using Django, you can configure the settings which will be loaded using the environment variables DJANGO_SETTINGS_MODULE (defaulting to ninetofiver.settings) and DJANGO_CONFIGURATION (defaulting to Dev).

The application will also attempt to load a YAML configuration file from a location specified using the environment variable CFG_FILE_PATH (defaulting to /etc/925r/config.yml) and use the resulting data to override existing settings.

For example, if you wanted to override the secret key used for production you could use the following configuration:

# Use your own secret key!
SECRET_KEY: mae3fo4dooJaiteth2emeaNga1biey9ia8FaiQuooYoac8phohee7r

Run the test suite:

python manage.py testninetofiver

Generate the docs:

pip install sphinx
sphinx-apidoc -e -f -a -d 2 -o docs ninetofiver ninetofiver/migrations
cd docs && make html && cd ../

See LICENSE

ninetofiver (925r): a free and open source time and leave tracking application.
Copyright (C) 2016 Kalman Olah

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.