mrsarm/django-coleman repository overview

Django Coleman⁠: A very simple Task Management web app written with Django Admin.

⁠Features

• Simple task manager that allows to define a tasks with title, partner (customer, provider...), description, responsible of the task, priority...
• Each task may have items: sub-tasks to be done.
• The built-in Django Authentication and Authorization system to manage users and groups, login, etc.
• Module django-adminfilters⁠ that allows multiselection searches.
• Send emails when a task is created.
• Spanish translations.
• Basic Rest API configuration (disabled by default, check the INSTALLED_APPS setting).
• Optionally, you can use Django Coleman along with Django Coleman Viewer⁠ to allows users to follow the orders.
• Pytest with some tests as example and code coverage reports configured.
• Docker and Docker Compose configurations (images published in Docker Hub⁠).
• CI environment, and E2E tests written with Playwright: dcoleman-e2e⁠. CI is executed with GitHub Actions, and executed on each push in this project, the viewer repo, or the E2E repo itself. The task also releases the image in the Docker Registry.
• Ready to use "production" configurations as reference.

⁠Run

You have to run this image, a Postgres instance, and optionally the tasks viewer⁠. The easiest way to run all at once is using Docker Compose, you can just copy the compose file and the reference .env file in any place with:

$ curl https://raw.githubusercontent.com/mrsarm/dcoleman-e2e/main/compose.yaml -o compose.yaml
$ curl https://raw.githubusercontent.com/mrsarm/dcoleman-e2e/main/.env.example -o .env

Then execute (only the first time):

$ docker compose pull

And after all the images were downloaded, each time you want to run the stack:

$ docker compose up

The first time it runs also the provision task that creates the DB, runs the migrations, and even a user admin with password admin1234 is created.

To access the app, go to http://localhost:8000/admin⁠ , and use the user and password above to enter the admin.

After create your first task in the Admin, to view it with the task viewer, if the id is 1 (likely), it can be viewed at http://localhost:8888/1?t=porgs⁠ .