Giter VIP home page Giter VIP logo

matorral-project / matorral Goto Github PK

View Code? Open in Web Editor NEW
63.0 3.0 12.0 1.88 MB

馃搰 A very simple & extensible project managent system built using Django & HTMX. Open Source JIRA, Trello, Linear, Clickup, Asana, Shourtcut.io Alternative.

License: Mozilla Public License 2.0

Python 69.18% HTML 30.61% CSS 0.08% Dockerfile 0.14%
management-system agile-development django python3 python bulma-css bulma-css-framework project-management project-management-tool project-management-system htmx task-management task-management-system task-manager todo

matorral's Introduction

matorral

Python Compatibility Django Compatibility

Overview

A very simple project managent tool built with Django & Bulma.io.

Here are some screenshots:

Features

  • Create, edit, delete and list (with pagination) and search Stories, Epics and Sprints
  • Stories have assignee, status, priority, points and optionally belong to an Epic and Sprint
  • Epics have the same fields and they track progress
  • Sprints have start and end dates, and also track progress
  • Workspaces to separate stories, epics and sprints
  • Login / logout

Roadmap

  • Migrate from Turbolinks to HTMX <3
  • Enhance test coverage
  • Run using docker
  • Upgrade to Bulma 1.0
  • Dark mode
  • Support for multiple themes
  • Realtime updates
  • Milestones
  • Subtasks
  • Projects
  • Multiple assigness
  • Kanban view
  • History
  • Comments everywhere
  • Attachments for Stories, Epics and Milestones
  • Import data from Jira, Github, Asana, etc

Quick Start

There are 2 ways to run the project: using Docker or installing it locally (using hatch).

Run using Docker

  1. Clone the repository:
git clone [email protected]:matorral-project/matorral.git
cd matorral
  1. Create the .env file (and customize it if you want):
cp config/env.example config/.env
  1. Run the following command:
docker-compose up -d
  1. Create a superuser:
docker-compose run --rm web sh -c "hatch run prod:python manage.py createsuperuser"

You will be asked a username, email and password for the superuser at the end of the process.

  1. Open your browser at http://localhost:8000 and login using the user credentials you created in step 3.

Install and run locally

  1. Clone the repository:
git clone [email protected]:matorral-project/matorral.git
cd matorral
  1. Install hatch using pip:
pip install hatch

or see instructions for alternative methods.

  1. Run the install command:
hatch run local:install

This will create the database, run the migrations, setup the config/.env configuration file and create a superuser/. You will be asked a username, email and password for the superuser at the end of the process.

  1. Run the web server:
hatch run local:server
  1. Open your browser at http://localhost:8000 and login using the user credentials you created in step 3.

Run Tests

hatch run test:test will run the tests in every Python + Django versions combination.

hatch run test.py3.11-4.2:test will run them for python 3.11 and Django 4.2. Please see possible combinations using hatch env show` ("test" matrix).

Contributing

Contributions are welcome! 鉂わ笍

License

MPL

matorral's People

Contributors

dependabot[bot] avatar matagus avatar nachopro avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

matorral's Issues

Error during installation following README.md steps - Missing DJANGO_SECRET_KEY

Operating System

Windows 11 Pro 23H2

Package Version

No response

Python Version

3.12

Description

Hi,

I encountered an issue while following the installation steps in the README.md. I attempted the installation using both Docker and Hatch, but I received the following error each time:

`Traceback (most recent call last):
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\environ\environ.py", line 388, in get_value
value = self.ENVIRON[var_name]
~~~~~~~~~~~~^^^^^^^^^^
File "", line 685, in getitem
KeyError: 'DJANGO_SECRET_KEY'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
File "path_to_project\manage.py", line 10, in
execute_from_command_line(sys.argv)
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\core\management_init_.py", line 442, in execute_from_command_line
utility.execute()
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\core\management_init_.py", line 436, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\core\management\base.py", line 413, in run_from_argv
self.execute(*args, **cmd_options)
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\core\management\base.py", line 459, in execute
output = self.handle(*args, **options)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\core\management\base.py", line 104, in wrapper
saved_locale = translation.get_language()
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\utils\translation_init_.py", line 211, in get_language
return trans.get_language()
^^^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\utils\translation_init
.py", line 66, in getattr
if settings.USE_I18N:
^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\conf_init_.py", line 89, in getattr
self.setup(name)
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\conf_init
.py", line 76, in setup
self.wrapped = Settings(settings_module)
^^^^^^^^^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\django\conf_init
.py", line 190, in init
mod = importlib.import_module(self.SETTINGS_MODULE)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "path_to_python\Lib\importlib_init
.py", line 90, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "", line 1387, in _gcd_import
File "", line 1360, in _find_and_load
File "", line 1331, in _find_and_load_unlocked
File "", line 935, in _load_unlocked
File "", line 995, in exec_module
File "", line 488, in _call_with_frames removed
File "path_to_project\config\settings.py", line 30, in
SECRET_KEY = env("DJANGO_SECRET_KEY")
^^^^^^^^^^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\environ\environ.py", line 199, in call
return self.get_value(
^^^^^^^^^^^^^^^
File "path_to_hatch\env\virtual\matorral\oa8CtWIB\local\Lib\site-packages\environ\environ.py", line 392, in get_value
raise ImproperlyConfigured(error_msg) from exc
django.core.exceptions.ImproperlyConfigured: Set the DJANGO_SECRET_KEY environment variable
`

Attempting to run

Hi!

Cool project, I'm attempting to run it locally for a demonstration. I have installed a venv using conda with Python 3.7 as it says in the instructions, but it won't install the requirements, as Django 4.x is only for Python 3.8 and up. When i tried Python 3.8, then it wouldn't install some other component of Django:

Collecting django-admin-list-filter-dropdown==1.0.2 (from -r requirements\base.t
xt (line 34))
  Downloading django_admin_list_filter_dropdown-1.0.2-py3-none-any.whl (3.8 kB)
ERROR: Ignored the following versions that require a different python version: 5
.0 Requires-Python >=3.10; 5.0.1 Requires-Python >=3.10; 5.0a1 Requires-Python >
=3.10; 5.0b1 Requires-Python >=3.10; 5.0rc1 Requires-Python >=3.10
ERROR: Could not find a version that satisfies the requirement django-comments-x
td-2.9.8 (from versions: none)
ERROR: No matching distribution found for django-comments-xtd-2.9.8

Process finished with exit code 1.

Could you help me out with getting started? Any help is appreciated.

-Rob

Git clone error

Operating System

Window 11

Package Version

No response

Python Version

No response

Description

Getting the error below when trying to clone the repo

Cloning into 'matorral'...
[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

Full django project structure

Por ahora hice s贸lo un minimal.py + requirements.txt para salir r谩pido, pero lo mejor es tener una estructura full de proyecto, con reqs modularizados, test suite start point, settings + urls, apps directory, celery integrado, monitoreo con sentry, etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    馃枛 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 馃搳馃搱馃帀

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google 鉂わ笍 Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.