adfinissygroup/timed-backend repository overview

⁠Timed Backend

Timed timetracking software REST API built with Django

⁠Installation

Requirements

• docker
• docker-compose

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

Add the timed.local entries to your hosts file:

echo "127.0.0.1 timed.local" | sudo tee -a /etc/hosts

Then just start the docker-compose setup:

make start

This brings up complete local installation, including our Timed Frontend⁠ project.

You can visit it at http://timed.local⁠.

The API can be accessed at http://timed.local/api/v1⁠ and the admin interface at http://timed.local/admin/⁠.

The Keycloak admin interface can be accessed at http://timed.local/auth/admin⁠ with the account admin and password admin

⁠Development

To get the application working locally for development, make sure to create a file .env with the following content:

ENV=dev
DJANGO_OIDC_CREATE_USER=True

If you have existing users from the previous LDAP authentication, you want to add this line as well:

DJANGO_OIDC_USERNAME_CLAIM=preferred_username

The test data includes 3 users admin, fritzm and alexs with you can log into http://timed.local⁠

The username and password are identical.

To access the Django admin interface you will have to change the admin password in Django directly:

$ make shell
root@0a036a10f3c4:/app# python manage.py changepassword admin
Changing password for user 'admin'
Password: 
Password (again): 
Password changed successfully for user 'admin'

Then you'll be able to login in the Django admin interface http://timed.local/admin/⁠.

⁠Adding a user

If you want to add other users with different roles, add them in the Keycloak interface (as they would be coming from your LDAP directory). You will also have to correct their employment in the Django admin interface as it is not correctly set for the moment. Head to http://timed.local/admin/⁠ after having perform a first login with the user. You should see that new user in the Employment -> Users. Click on the user and scroll down to the Employments section to set a Location. Save the user and you should now see the Timed interface correctly under that account.

⁠Configuration

Following options can be set as environment variables to configure Timed backend in documented format⁠ according to type.

⁠Contributing

Look at our contributing guidelines⁠ to start with your first contribution.

⁠License

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