Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.46 KB

README.md

File metadata and controls

32 lines (26 loc) · 1.46 KB
Raw

Timed Backend

Build Status Coverage License

Timed timetracking software REST API built with Django

Installation

Requirements

  • python 3.5.2
  • docker
  • docker-compose

After installing and configuring those requirements, you should be able to run the following commands to complete the installation:

$ make install                                 # Install Python requirements
$ cp timed/config.sample.ini timed/config.ini  # Use the sample config file
$ docker-compose up -d                         # Start the containers
$ make setup-ldap                              # Configure UCS LDAP container
$ make create-ldap-user                        # Create a new standard user
$ ./manage.py migrate                          # Run Django migrations
$ ./manage.py createsuperuser                  # Create a new Django superuser

You can now access the API at http://localhost:8000/api/v1 and the admin interface at http://localhost:8000/admin/

Testing

Run tests by executing make test

License

Code released under the GNU Affero General Public License v3.0.