inuits/925r

Name: 925r

Owner: Inuits

Description: ninetofiver (925r): a free and open source time and leave tracking application.

Created: 2017-06-08 08:52:54.0

Updated: 2017-06-08 08:52:56.0

Pushed: 2017-06-02 13:36:49.0

Homepage:

Size: 408

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

ninetofiver

Build Status Coverage Status Documentation Status GitHub issues license

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

Installation

Create and activate a virtual environment:

on3 -m virtualenv -p python3 ninetofiver_venv
ce ninetofiver_venv/bin/activate

Install build dependencies:

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

Install the application:

on setup.py install
install -r requirements.txt
Usage
  1. Run python manage.py migrate to create the models.

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

Running (Docker)

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.

er-compose -f ./scripts/docker/docker-compose.yml up
Running (development)

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

on manage.py runserver
Running (production)

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.

on manage.py runserver --configuration=Prod --insecure
Configuration

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:

e your own secret key!
ET_KEY: mae3fo4dooJaiteth2emeaNga1biey9ia8FaiQuooYoac8phohee7r
Testing

Run the test suite:

on manage.py testninetofiver
Documentation

Generate the docs:

install sphinx
nx-apidoc -e -f -a -d 2 -o docs ninetofiver ninetofiver/migrations
ocs && make html && cd ../
Database Structure

Database ERD

License

See LICENSE

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

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

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

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

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.