Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matorral-project/matorral

📇 A very simple & extensible project managent system built using Django & HTMX. Open Source JIRA, Trello, Linear, Clickup, Asana, Shourtcut.io Alternative.
https://github.com/matorral-project/matorral

agile-development bulma-css bulma-css-framework django htmx management-system project-management project-management-system project-management-tool python python3 task-management task-management-system task-manager todo

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/matorral-project/matorral
Owner: matorral-project
License: mpl-2.0
Created: 2019-05-20T18:01:01.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-03-26T02:13:44.000Z (6 months ago)
Last Synced: 2024-05-17T16:18:40.839Z (4 months ago)
Topics: agile-development, bulma-css, bulma-css-framework, django, htmx, management-system, project-management, project-management-system, project-management-tool, python, python3, task-management, task-management-system, task-manager, todo
Language: Python
Homepage:
Size: 1.83 MB
Stars: 51
Watchers: 2
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
- Authors: AUTHORS.md

Awesome Lists containing this project

README

# matorral

![Python Compatibility](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue.svg) ![Django Compatibility](https://img.shields.io/badge/django-4.0%20%7C%204.1%20%7C%204.2%20%7C%205.0-green.svg)

## Overview

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

Here are some screenshots:

![](https://github.com/matagus/matorral/raw/main/matorral/static/screenshots/stories-1.png)

![](https://github.com/matagus/matorral/raw/main/matorral/static/screenshots/stories-2.png)

![](https://github.com/matagus/matorral/raw/main/matorral/static/screenshots/stories-4.png)

![](https://github.com/matagus/matorral/raw/main/matorral/static/screenshots/epics-1.png)

![](https://github.com/matagus/matorral/raw/main/matorral/static/screenshots/sprints-1.png)

## 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:

```bash
git clone [email protected]:matorral-project/matorral.git
cd matorral
```

2. Create the .env file (and customize it if you want):
```bash
cp config/env.example config/.env
```

3. Run the following command:

```bash
docker-compose up -d
```

4. Create a superuser:

```bash
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.

4. Open your browser at [http://localhost:8000](http://localhost:8000) and login using the user credentials you created
in step 3.

### Install and run locally

1. Clone the repository:

```bash
git clone [email protected]:matorral-project/matorral.git
cd matorral
```

2. Install [hatch](https://hatch.pypa.io/latest/) using `pip`:

```
pip install hatch
```

or see [instructions for alternative methods](https://hatch.pypa.io/latest/install/).

3. 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.

4. Run the web server:

```
hatch run local:server
```

5. Open your browser at [http://localhost:8000](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](https://www.mozilla.org/en-US/MPL/)