raclettes/application-mission

Application pour affecter des tâches à des utilisateurs

(English here)

Application Mission

Ceci est une application pour affecter des tâches à des utilisateurs et les modifier après les avoir faits. Cette application était fait pour une mission d'un job, et est sous le license AGPL.

Cette application n'est pas prête pour production, et est actuellement seulement approprié pour localhost.

Vous pouvez trouver des captures d'écran dans screenshots/.

Commencer

Pour commencer, il faut installer Android Studio, et Python.

Base de données

Pour configurer la base de données, MySQL de préférence, vous vouvez lire la guide suivante : https://dev.mysql.com/doc/mysql-getting-started/en/. N'oubliez pas le lien de votre base de données, vous en avez besoin pour la variable SQLALCHEMY_DATABASE_URI.

Backend

Pour la partie backend, il faudra installer les requirements et puis lancer le backend.

• Installer les requirements

  cd backend
  python -m pip install -r requirements.txt

• Lancer le backend

  cd .. # rentre au root du projet
  python -m backend

  Il va se lancer avec toutes les informations nécessaires (voir environment variables)

Frontend

Le frontend est une application fait en Kotlin pour Android 11 (API 30) Java 1.8. Pour le lancer, il faut ouvrir le dossier frontend avec Android Studio, puis lancer l'application sur votre appareil préféré.

A l'instant, il se connecte à 10.0.2.2, qui est l'adressse IP du hôte (quand on utilise un émulateur). Vous pouvez changer cette adresse dans MainActivity.kt:39.

Variables

Les variables de l'environment sont:

• JWT_SECRET: Le secret utilisé pour configurer les jetons JWT. (Si pas fourni, il sera généré à chaque lancement. Tout jeton précedent sera invalidé.)
• SQLALCHEMY_DATABASE_URI: L'adresse de la base de données (si aucune adresse est fournie, il va utiliser une base de données SQLite en memoire)
• SECRET_KEY: Le secret utilisé par Flask pour configuer les jetons session (non utilisé par l'application, mais quand même nécessaire). Si pas fourni, il sera généré automatiquement. Pas comme le JWT_SECRET, il n'est pas forcément suggeré de le fournir.

Autres informations

Les jetons JWT fourni par le backend dure, par défaut, une heure. Après une heure, l'utilisateur aura besoin de se connecter à nouveau.

Notes

Cette application ayant été fait pour une mission d'un job, il y a quelques trucs que je ferais différement si j'avais plus de temps, y compris :

• Utiliser SSL pour le backend (et un backend plus configurable).
• Permettre aux utilisateurs de cacher des tâches d'autres utilisateurs.
• Un système de permissions, pour permettre à certains utilisateurs de créer des tâches, mais pas les affecter à d'autres utilisateurs par exemple.
• Créer un système kanban.

English

This is an application for assigning tasks to users and modifying them after they are done. This application was made for a job task, and is licensed under the AGPL.

This application is not ready for production, and is currently only suitable for localhost.

You can find screenshots in screenshots/

Getting started

To get started, you need to install Android Studio, and Python.

Database

To configure the database, which is MySQL preferably, you can use the following guide: https://dev.mysql.com/doc/mysql-getting-started/en/. Don't forget the DB URI, you need it for the environment variable SQLALCHEMY_DATABASE_URI.

Backend

For the backend part, you will need to install the requirements and then run the backend.

• Install the requirements

  cd backend
  python -m pip install -r requirements.txt

• Run the backend

  cd . # return to the root of the project
  python -m backend

  It will run with all the necessary information (see environment variables)

Frontend

The frontend is an application made in Kotlin for Android 11 (API 30) Java 1.8. To launch it, you need to open the frontend folder with Android Studio, then launch the application on your preferred device.

Right now, it connects to 10.0.2.2, which is the IP address of the host (when using an emulator). You can change this address in MainActivity.kt:39.

Environment Variables

The environment variables are:

• JWT_SECRET: The secret used to set up the JWT tokens. (If not supplied, it will be generated at each run. Any previous tokens will be invalidated).
• SQLALCHEMY_DATABASE_URI: The database address (if no address is provided, it will use a SQLite database in memory)
• SECRET_KEY: The secret used by Flask to set up the session tokens (not used by the application, but still needed). If not provided, it will be generated automatically. Unlike the JWT_SECRET, it is not necessarily suggested to provide it.

Other information

The JWT tokens provided by the backend last, by default, one hour. After one hour, the user will then need to log in again.

Notes

As this application was made for a job assignment, there are a few things I would do differently if I had more time, including :

• Use SSL for the backend (and a more configurable backend).
• Allow users to hide tasks from other users.
• A permissions system, to allow some users to create tasks, but not assign them to other users for example.
• Create a kanban system.