https://github.com/umactually/devotion-backend

Last synced: 7 months ago
JSON representation

Host: GitHub
URL: https://github.com/umactually/devotion-backend
Owner: UmActually
Created: 2024-03-05T15:54:46.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-01-16T15:14:49.000Z (over 1 year ago)
Last Synced: 2025-01-29T12:22:18.400Z (over 1 year ago)
Language: Python
Homepage:
Size: 214 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# D. E. V. O. T. I. O. N.

> Development Environment for the Visualization of Organizational Tasks Inspired Obviously by Notion

## Setup del back end

Requiere Python 3.9 o superior.

```bash
pip install -r requirements.txt
gunicorn devotion.wsgi
```

## API bonita

☆ = Requiere autenticación de token Bearer.

Para crear o actualizar un recurso, el usuario debe ser líder del proyecto papá. La única excepción a esto es PUT `/tasks//status/`, que puede ser ejecutado por cualquier miembro del proyecto. Ser un superuser sobrepasa todas estas restricciones.

- GET `/test/` - _Hola, mundo_

**Users**

- POST `/users/` - _[Crear usuario](#post-users---crear-usuario)_
- POST `/login/` - _[Iniciar sesión](#post-login---iniciar-sesi%C3%B3n)_
- GET `/users/` - _[Obtener todos los usuarios ☆](#get-users---obtener-todos-los-usuarios-)_
- GET `/me/` - _[Obtener usuario ☆](#get-me---obtener-usuario-)_
- PUT `/me/` - _[Actualizar usuario ☆](#put-me---actualizar-usuario-)_
- GET `/me/projects/` - _[Obtener proyectos del usuario ☆](#get-meprojects---obtener-proyectos-del-usuario-)_
- GET `/me/calendar/` - _[Obtener calendario global del usuario ☆](#get-mecalendar---obtener-calendario-global-del-usuario-)_

**Projects**

- POST `/projects/` - _[Crear proyecto ☆](#post-projects---crear-proyecto-)_
- GET `/projects//` - _[Obtener proyecto](#get-projectsid---obtener-proyecto)_
- GET `/projects//members/` - _[Obtener miembros del proyecto ☆](#get-projectsidmembers---obtener-miembros-del-proyecto-)_
- PUT `/projects//` - _[Actualizar proyecto ☆](#put-projectsid---actualizar-proyecto-)_
- DELETE `/projects//` - _[Eliminar proyecto ☆](#delete-projectsid---eliminar-proyecto-)_

**Tasks**

- POST `/tasks/` - _[Crear tarea ☆](#post-tasks---crear-tarea-)_
- GET `/tasks//` - _[Obtener tarea](#get-tasksid---obtener-tarea)_
- PUT `/tasks//` - _[Actualizar tarea ☆](#put-tasksid---actualizar-tarea-)_
- PUT `/tasks//status/` - _[Cambiar estado de tarea ☆](#put-tasksidstatus---cambiar-estado-de-tarea-)_
- DELETE `/tasks//` - _[Eliminar tarea ☆](#delete-tasksid---eliminar-tarea-)_

**Dashboard (Aún no tan)**

- GET `/projects//dashboard/` - _Obtener dashboard del proyecto_
- POST `/projects//dashboard/widgets/` - _Crear widget_
- PUT `/projects//dashboard/widgets/` - _Actualizar widget_
- POST `/projects//dashboard/sources/` - _Crear fuente de datos_

---

### Users

#### POST `/users/` - _Crear usuario_

**Entrada**

- `email`
- `password`
- `first_names`
- `last_names`

**Salida**

```json
{
"id": 1,
"token": "eyJ0..."
}
```

---

#### POST `/login/` - _Iniciar sesión_

**Entrada**

- `email`
- `password`

**Salida**

```json
{
"access": "eyJ0...",
"refresh": "eyJ0..."
}
```

---

#### GET `/users/` - _Obtener todos los usuarios ☆_

**Salida**

```json
[
{
"id": "e729a80d-0033-4e0e-8891-20085212b445",
"email": "sergioperez@example.com",
"firstNames": "Sergio",
"lastNames": "Pérez"
},
{
"id": "42e74cee-497c-41f5-834e-ac3578229cb6",
"email": "lewishamilton@example.com",
"firstNames": "Lewis",
"lastNames": "Hamilton"
},
...
]
```

---

#### GET `/me/` - _Obtener usuario ☆_

**Salida**

```json
{
"id": "e729a80d-0033-4e0e-8891-20085212b445",
"email": "sergioperez@example.com",
"firstNames": "Sergio",
"lastNames": "Pérez"
}
```

---

#### PUT `/me/` - _Actualizar usuario ☆_

**Entrada**

- `email` (opcional)
- `first_names` (opcional)
- `last_names` (opcional)

---

#### GET `/me/projects/` - _Obtener proyectos del usuario ☆_

**Salida**

```json
[
{
"id": "4bfca576-83d2-447a-9b79-cdc778417c84",
"name": "FSAE 2024",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin volutpat tortor eget lacus ultricies, nec ullamcorper risus viverra. Pellentesque non ultrices nibh."
},
...
]
```

---

#### GET `/me/calendar/` - _Obtener calendario global del usuario ☆_

**Salida**

Nota: las fechas son arreglos de dos números, que representan la posición de la tarea (o tareas) en la matriz del calendario.

```json
{
"tasks": [
{
"date": [
0,
1
],
"tasks": [
{
"id": "f8ed4488-0fbc-44b4-9b96-c626caf6a44a",
"name": "Junta inicial 123",
"status": 2,
"priority": 0
},
...
]
},
...
],
"today": [
1,
5
]
}
```

---

### Projects

#### POST `/projects/` - _Crear proyecto ☆_

**Entrada**

- `name`
- `description`
- `parent` (opcional) - _ID del proyecto papá_
- `leaders` - _IDs de usuarios líderes separados por ","_
- `members` - _IDs de usuarios miembros separados por ","_

---

#### GET `/projects//` - _Obtener proyecto_

**Query params**

- `get` - _Para obtener respuestas parciales de solo la información del proyecto o solo las tareas del mismo (sí ahorra mucho tiempo)._
- _Opciones: `info`, `tasks`, `all`, default es `all`_
- `view` - _Cambia el formato de la respuesta para facilitar el front._
- _Opciones: `table`, `kanban`, `calendar`, default es `table`_
- `assigned` - _Mostrar solo tareas asignadas al usuario. Si la request no tiene autenticación, este parámetro se ignora._
- _Opciones: `true`, `false`, default es `false`_
- `subtree` - _Mostrar todo el subárbol de tareas debajo del proyecto actual._
- _Opciones: `true`, `false`, default es `false`_

**Salida**

Parámetros default:

```json
{
"id": "887ebfdd-bd39-417c-9b42-90396c2b8e59",
"name": "Chasis",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin volutpat tortor eget lacus ultricies, nec ullamcorper risus viverra. Pellentesque non ultrices nibh.",
"breadcrumbs": [
[
"4bfca576-83d2-447a-9b79-cdc778417c84",
"FSAE 2024",
false
],
...
],
"projects": [
{
"id": "169bdff0-30d5-4b7f-ad7a-c2793a1a7328",
"name": "Cockpit",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin volutpat tortor eget lacus ultricies, nec ullamcorper risus viverra. Pellentesque non ultrices nibh."
},
...
],
"tasks": [
{
"id": "0191827d-1e38-4647-885c-aef73ea494b0",
"name": "Peso y distribución",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incidid.",
"status": 3,
"priority": 0,
"startDate": "2024-02-13",
"dueDate": "2024-02-21",
"assignee": "Alexander Albon",
"parentProject": "887ebfdd-bd39-417c-9b42-90396c2b8e59",
"parentTask": null
},
...
],
"progress": 50
}
```

Ejemplo con get=`tasks`&view=`calendar`:

Nota: las fechas son arreglos de dos números, que representan la posición de la tarea (o tareas) en la matriz del calendario.

```json
{
"tasks": [
{
"date": [
0,
3
],
"tasks": [
{
"id": "9bcfd443-9ff2-42cd-b69e-75aa032891e1",
"name": "Diseño del chasis",
"status": 0,
"priority": 0
},
...
]
},
...
],
"today": [
1,
5
]
}
```

Ejemplo con get=`tasks`&view=`kanban`:

```json
{
"tasks": {
"notStarted": [
{
"id": "95a7529b-e750-4c2a-867c-cdb9b167ae34",
"name": "Investigación de nuevos materiales para la construcción del chasis",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incidid.",
"priority": 1,
"assignee": {
"id": "f8c2280f-3840-490f-b85a-0779badd8f66",
"name": "George Russell"
}
},
...
],
"inProgress": [
...
],
"inReview": [
...
],
"done": [
...
]
}
}
```

---

#### GET `/projects//members/` - _Obtener miembros del proyecto ☆_

**Salida**

```json
[
{
"id": "4fceb6df-d3ac-4f5a-b177-995ac5673d1a",
"email": "valtteribottas@example.com",
"firstNames": "Valtteri",
"lastNames": "Bottas"
},
...
]
```

---

#### PUT `/projects//` - _Actualizar proyecto ☆_

**Entrada**

- `name` (opcional)
- `description` (opcional)
- `parent` (opcional) - _ID del proyecto papá_
- `leaders` (opcional) - _IDs de usuarios líderes separados por ","_
- `members` (opcional) - _IDs de usuarios miembros separados por ","_

---

#### DELETE `/projects//` - _Eliminar proyecto ☆_

---

### Tasks

#### POST `/tasks/` - _Crear tarea ☆_

**Entrada**

- `name`
- `description` (opcional)
- `priority` (opcional) - _Entero. 0 es baja, 1 es media, 2 es alta, default es 0_
- `start_date` (opcional) - _Fecha de inicio en formato YYYY-MM-DD, default es hoy, o `due_date` si ésta es del pasado_
- `due_date` - _Formato YYYY-MM-DD_
- `parent_project` - _ID del proyecto papá_
- `parent_task` (opcional) - _ID de la tarea papá_
- `assignee` - _ID del usuario asignado_

---

#### GET `/tasks//` - _Obtener tarea_

**Query params**

- `get` - _Para obtener respuestas parciales de solo la información de la tarea o solo las subtareas de la misma (sí ahorra mucho tiempo)._
- _Opciones: `info`, `tasks`, `all`, default es `all`_
- `view` - _Cambia el formato de la respuesta para facilitar el front._
- _Opciones: `table`, `kanban`, `calendar`, default es `table`_
- `assigned` - _Mostrar solo tareas asignadas al usuario. Si la request no tiene autenticación, este parámetro se ignora._
- _Opciones: `true`, `false`, default es `false`_
- `subtree` - _Mostrar todo el subárbol de tareas debajo de la tarea actual._
- _Opciones: `true`, `false`, default es `false`_

**Salida**

Ejemplo con parámetros default:

```json
{
"id": "0191827d-1e38-4647-885c-aef73ea494b0",
"name": "Peso y distribución",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incidid.",
"status": 3,
"priority": 0,
"startDate": "2024-02-13",
"dueDate": "2024-02-21",
"assignee": "Alexander Albon",
"breadcrumbs": [
[
"4bfca576-83d2-447a-9b79-cdc778417c84",
"FSAE 2024",
false
],
...
],
"tasks": [
{
"id": "0191827d-1e38-4647-885c-aef73ea494b0",
"name": "Peso y distribución",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incidid.",
"status": 3,
"priority": 0,
"startDate": "2024-02-13",
"dueDate": "2024-02-21",
"assignee": "Alexander Albon",
"parentProject": "887ebfdd-bd39-417c-9b42-90396c2b8e59",
"parentTask": null
},
...
]
}
```

Ejemplo con get=`tasks`&view=`calendar`:

Nota: las fechas son arreglos de dos números, que representan la posición de la tarea (o tareas) en la matriz del calendario.

```json
{
"tasks": [
{
"date": [
0,
3
],
"tasks": [
{
"id": "9bcfd443-9ff2-42cd-b69e-75aa032891e1",
"name": "Diseño del chasis",
"status": 0,
"priority": 0
},
...
]
},
...
],
"today": [
1,
5
]
}
```

Ejemplo con get=`tasks`&view=`kanban`:

#### PUT `/tasks//` - _Actualizar tarea ☆_

**Entrada**

- `name` (opcional)
- `description` (opcional)
- `priority` (opcional) - _Entero. 0 es baja, 1 es media, 2 es alta, default es 0_
- `start_date` (opcional) - _Fecha de inicio en formato YYYY-MM-DD, default es hoy, o `due_date` si ésta es del pasado_
- `due_date` (opcional) - _Formato YYYY-MM-DD_
- `parent_project` (opcional) - _ID del proyecto papá_
- `parent_task` (opcional) - _ID de la tarea papá_
- `assignee` (opcional) - _ID del usuario asignado_

---

#### PUT `/tasks//status/` - _Cambiar estado de tarea ☆_

**Entrada**

- `status` - _Entero. 0 es pendiente, 1 es en progreso, 2 es en revisión, 3 es completada_

---

#### DELETE `/tasks//` - _Eliminar tarea ☆_

---

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/umactually/devotion-backend

Awesome Lists containing this project

README