-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a translation script using deepl, quick test on the FR side, -> s…
…eems good enough
- Loading branch information
1 parent
0b3ab8f
commit 3ada463
Showing
17 changed files
with
333 additions
and
266 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
DEEPL_API_KEY=your_deepl_api_key_here_if_you_want_auto_translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
book | ||
.cache | ||
site | ||
site | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,52 @@ | ||
## Configuration des e-mails entrants | ||
## Configurer les courriels entrants | ||
|
||
Cette étape supplémentaire vous permet d'avoir une boîte aux lettres pour chaque groupe afin que les membres puissent publier par e-mail pour créer des discussions et répondre aux e-mails de discussion pour créer de nouveaux commentaires. | ||
Cette étape supplémentaire vous permet d'avoir une boîte aux lettres pour chaque groupe afin que les membres puissent envoyer des messages par courriel pour créer des discussions et répondre aux courriels des discussions pour créer de nouveaux commentaires. | ||
|
||
NOTE: La prise en charge des e-mails entrante est expérimentale mais utilisée dans plusieurs cas.Vous pourriez cependant découvrir des bogues, veuillez les signaler si cela arrive à votre installation. | ||
! !! note | ||
Le support des emails entrants est expérimental mais utilisé sur plusieurs instances. Il est possible que vous rencontriez des bogues, veuillez les signaler si cela se produit dans votre installation. | ||
|
||
|
||
- Vous avez besoin d'une adresse e-mail sur un serveur avec support IMAP. Il doit être soit une capture sur un sous-domaine (ou même sur un domaine) ou un serveur prenant en charge "+" l'adressage (Gmail par exemple le permet). | ||
- Vous avez besoin de l'extension PHP IMAP | ||
- La configuration se produit dans votre .env | ||
- Vous avez besoin d'une adresse email sur un serveur supportant l'imap. Il doit s'agir d'une adresse "catch all" sur un sous-domaine (ou même sur un domaine) ou d'un serveur supportant l'adressage "+" (gmail par exemple le permet). | ||
- Vous avez besoin de l'extension php imap | ||
- La configuration se fait dans votre .env | ||
|
||
Disons que vous avez installé Agorakit sur agora.example.org: | ||
Disons que vous avez installé Agorakit sur agora.example.org : | ||
|
||
- Créez une boîte aux lettres Catchall sur *. @ Agora.example.org | ||
- Modifiez votre fichier .env et ajoutez / définissez les paramètres suivants: | ||
- Créer une boîte aux lettres catchall sur * .@agora.example.org | ||
- Editez votre fichier .env et ajoutez/définissez les paramètres suivants : | ||
|
||
`` ' | ||
# Paramètres du serveur de boîtes à lettres de réception, utilisation pour les e-mails entrants. | ||
# Définissez Inbox_Driver sur NULL pour désactiver cette fonctionnalité | ||
Inbox_Driver = IMAP | ||
Inbox_host = yourmailhost.tld | ||
Inbox_Username = nom d'utilisateur de la boîte aux lettres | ||
Inbox_password = mot de passe de la boîte aux lettres | ||
Inbox_prefix = | ||
Inbox_Suffix=@agora.example.org | ||
``` | ||
# Paramètres du serveur de la boîte aux lettres, à utiliser pour les courriels entrants. | ||
# Définissez INBOX_DRIVER à null pour désactiver cette fonctionnalité | ||
INBOX_DRIVER=imap | ||
INBOX_HOST=votremailhost.tld | ||
INBOX_USERNAME=nom d'utilisateur de la boîte aux lettres | ||
INBOX_PASSWORD=mot de passe de la boîte aux lettres | ||
INBOX_PREFIX= | ||
INBOX_SUFFIX[email protected] | ||
`` ' | ||
``` | ||
|
||
|
||
### Préfixes et suffixes définissants | ||
Vous devez remplir le préfixe et le suffixe.Deux cas là-bas: | ||
### Définir les préfixes et les suffixes | ||
Vous devez renseigner le préfixe et le suffixe. Il y a deux cas de figure : | ||
|
||
|
||
- Pour un catch, tout il n'y a pas de préfixe.Le suffixe dans l'exemple ci-dessus serait `@ agora.example.org`.Cela créera des e-mails comme `Group-Slug @ agora.example.com` | ||
- Pour un catch all, il n'y a pas de préfixe. Le suffixe dans l'exemple ci-dessus serait `@agora.example.org` . Cela créera des courriels comme `group-slug@agora.example.com` | ||
|
||
- D'un autre côté, si vous utilisez "+" l'adressage (une boîte Gmail par exemple, appelons-le [email protected]), | ||
- En revanche, si vous utilisez l'adresse "+" (une boîte gmail par exemple, appelons-la [email protected]), | ||
|
||
- Le préfixe sera `agorakit +` | ||
- Le suffixe sera `@ gmail.com` | ||
- le préfixe sera `agorakit+` | ||
- le suffixe sera `@gmail.com`. | ||
|
||
Cela créera des e-mails comme `agorakit + groupe-slug @ gmail.com` | ||
Cela créera des emails comme `agorakit+group-slug@gmail.com` | ||
|
||
Si vous activez l'e-mail entrant, la boîte aux lettres sera automatiquement cochée et le courrier électronique traité sera placé dans un dossier "traité" dans la boîte de réception.Les e-mails échoués seront également placés dans un dossier "échoué" dans la boîte de réception pour l'inspection. | ||
Si vous activez les emails entrants, la boîte aux lettres sera automatiquement vérifiée et les emails traités seront placés dans un dossier "processed" sous INBOX. Les courriels échoués seront également placés dans un dossier "failed" sous INBOX pour inspection. | ||
|
||
|
||
## Authentification externe | ||
|
||
INOF: L'authentification externe a été supprimée.J'ai peu de gens (le cas échéant) de la demander.Il s'agit d'une fonctionnalité d'invasion de confidentialité, donc aucun développement n'a été effectué sur le front. | ||
! !! info | ||
L'authentification externe a été supprimée. Je n'ai que très peu (voire pas du tout) de personnes qui l'ont demandée. Il s'agit d'une fonctionnalité qui porte atteinte à la vie privée, c'est pourquoi aucun développement n'a été fait dans ce sens. N'hésitez pas à soumettre un PR si vous le souhaitez. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# Useful artisan commands | ||
# Commandes artisanales utiles | ||
|
||
Agorakit provides some useful [artisan](https://laravel.com/docs/7.x/artisan) commands : | ||
Agorakit fournit quelques commandes [artisan](https://laravel.com/docs/7.x/artisan) utiles : | ||
|
||
- `agorakit:checkmailbox` Check the configured email imap server to allow post by email functionality | ||
- `agorakit:cleanupdatabase` Cleanup the database, delete forever soft deleted models and unverified users older than 30 days | ||
- `agorakit:convertfiles` Convert the files from the old flat path based storage to the new storage, putting back their initila filename and moving the file to public directory. Use this **once** if you already have files on your install and if your install is older than november 2016. | ||
- `agorakit:convertfolderstotags` Convert all folders to the new tag based system. Add the tags represneting parent folder to each file | ||
- `agorakit:deletefiles` Delete files from storage after 30 days of deletion in database | ||
- `agorakit:export` Export a group to a zip file (work in progress) | ||
- `agorakit:import` Import a group from an Agorakit export zip file (work in progress) | ||
- `agorakit:populatefilesize` Set filesize in the files table using real filesize from the filesystem. Use this if you installed agorakit before november 2017 | ||
- `agorakit:sendnotifications` Sends all the pending notifications to all users who requested it. This might take time. Call this frequently to avoid trouble | ||
- `agorakit:sendreminders` Sends all reminders to participants who asked for it - call exactly every 5 minutes, no more, no less :-) | ||
- `agorakit:checkmailbox` Vérifier le serveur email imap configuré pour permettre la fonctionnalité de postage par email | ||
- `agorakit:cleanupdatabase` Nettoie la base de données, supprime pour toujours les modèles supprimés et les utilisateurs non vérifiés de plus de 30 jours. | ||
- `agorakit:convertfiles` Convertit les fichiers de l'ancien stockage basé sur le chemin plat vers le nouveau stockage, en remettant leur nom de fichier initial et en déplaçant le fichier vers le répertoire public. Utilisez ceci **une fois** si vous avez déjà des fichiers sur votre installation et si votre installation est antérieure à novembre 2016. | ||
- `agorakit:convertfolderstotags` Convertit tous les dossiers au nouveau système basé sur les tags. Ajouter les tags représentant le dossier parent à chaque fichier. | ||
- `agorakit:deletefiles` Supprime les fichiers du stockage après 30 jours de suppression dans la base de données. | ||
- `agorakit:export` Exporter un groupe vers un fichier zip (travail en cours) | ||
- `agorakit:import` Importer un groupe depuis un fichier zip d'exportation Agorakit (travail en cours) | ||
- `agorakit:populatefilesize` Fixe la taille des fichiers dans la table des fichiers en utilisant la taille réelle du système de fichiers. A utiliser si vous avez installé Agorakit avant novembre 2017. | ||
- `agorakit:sendnotifications` Envoie toutes les notifications en attente à tous les utilisateurs qui l'ont demandé. Cela peut prendre du temps. Appelez ceci fréquemment pour éviter les problèmes | ||
- `agorakit:sendreminders` Envoie tous les rappels aux participants qui l'ont demandé - appeler exactement toutes les 5 minutes, ni plus, ni moins :-) | ||
|
||
WARNING: Most of those commands are already used by the cron job, so they don't need to be called manually. But they might be useful for debugging and development. | ||
ATTENTION : La plupart de ces commandes sont déjà utilisées par le job cron, elles n'ont donc pas besoin d'être appelées manuellement. Mais elles peuvent être utiles pour le débogage et le développement. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
You can contact the Agorakit team directly on *info [at] agorakit [dot] org* | ||
Vous pouvez contacter l'équipe d'Agorakit directement sur *info [at] agorakit [dot] org*. | ||
|
||
You can also join the official developer's group here, on Agorakit of course : <https://app.agorakit.org/groups/39> | ||
Vous pouvez également rejoindre le groupe officiel de développeurs ici, sur Agorakit bien sûr : <https://app.agorakit.org/groups/39> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,66 @@ | ||
# Contributing to Agorakit | ||
# Contribuer à Agorakit | ||
|
||
You want to contribute to the project? Great! Any idea is welcome. | ||
Vous voulez contribuer au projet ? C'est très bien ! Toute idée est la bienvenue. | ||
|
||
- Please discuss the bug or feature request in the issue queue first. | ||
- Check the licence (AGPL) to see if it fits your contribution model | ||
- Follow Laravel best practices | ||
- We use Unpoly js for spa like functionality, read a bit about it since it's not as popular as other options (think of it as turbolinks on steroids) | ||
- We use Bootstrap flavored by tabler.io | ||
- Veuillez d'abord discuter du bogue ou de la demande de fonctionnalité dans la file d'attente des problèmes. | ||
- Vérifiez la licence (AGPL) pour voir si elle correspond à votre modèle de contribution. | ||
- Suivez les meilleures pratiques de Laravel | ||
- Nous utilisons Unpoly js pour les fonctionnalités de type spa, lisez un peu à son sujet car il n'est pas aussi populaire que les autres options (pensez-y comme des turbolinks sur les stéroïdes). | ||
- Nous utilisons Bootstrap aromatisé par tabler.io | ||
|
||
|
||
# Developement server | ||
# Serveur de développement | ||
|
||
## Using Laravel Sail | ||
Sail is a docker wrapper to ease local development. It's a really cool and easy way to have a perfect local server for devs. | ||
Laravel sail works out of the box in this project. Read the Sail documentation for more informations. | ||
## Utilisation de Laravel Sail | ||
Sail est un wrapper docker pour faciliter le développement local. C'est un moyen vraiment cool et facile d'avoir un serveur local parfait pour les développeurs. | ||
Laravel Sail fonctionne d'emblée dans ce projet. Lisez la documentation de Sail pour plus d'informations. | ||
|
||
This is what I use on my main workstation (linux based) since it's very reproductible. | ||
C'est ce que j'utilise sur ma station de travail principale (basée sur linux) car c'est très reproductible. | ||
|
||
Basically, `sail up` will start a developement server | ||
En gros, `sail up` va démarrer un serveur de développement | ||
|
||
|
||
## Using artisan serve | ||
## Utilisation de artisan serve | ||
|
||
If you want to start a local server for development: | ||
Si vous voulez démarrer un serveur local pour le développement : | ||
|
||
$ php artisan serve | ||
|
||
The install will be available to 127.0.0.1:8000 | ||
L'installation sera disponible pour 127.0.0.1:8000 | ||
|
||
There are a lot of other options, check the laravel doc and ecosystem to have an overview of the options for local developement. | ||
Il y a beaucoup d'autres options, consultez la documentation et l'écosystème de Laravel pour avoir une vue d'ensemble des options pour le développement local. | ||
|
||
# Seed the DB | ||
First follow the installation instructions including the creation of sample content using : | ||
# Création de la base de données | ||
Suivez d'abord les instructions d'installation, y compris la création d'un échantillon de contenu en utilisant : | ||
|
||
$ php artisan db:seed | ||
|
||
|
||
# Working on design and css | ||
# Travailler sur le design et les css | ||
|
||
I ditched all build steps, now everything happens in a flat custom.css file. | ||
J'ai supprimé toutes les étapes de construction, maintenant tout se passe dans un fichier custom.css plat. | ||
|
||
All external JS and CSS are served from various CDN's. At some point the files will be re-served from local, when everything will be stabilized, and if there are real benefits of doing so. | ||
Tous les JS et CSS externes sont servis par différents CDN. A un moment donné, les fichiers seront re-servis en local, quand tout sera stabilisé, et s'il y a de réels avantages à le faire. | ||
|
||
No npm, no node, no tailwind, no purge, no minifier, no trouble :) | ||
Pas de npm, pas de node, pas de tailwind, pas de purge, pas de minifier, pas de problème :) | ||
|
||
|
||
# Testing your code | ||
# Tester votre code | ||
|
||
Agorakit is tested using the Laravel testing framework. | ||
Agorakit est testé en utilisant le framework de test Laravel. | ||
|
||
In order to test, you need to have an existing testing database. Just create an additional empty DB, for instance agorakit_testing and check in the phpunit.xml file that everything matches. | ||
Pour tester, vous devez avoir une base de données de test existante. Il suffit de créer une nouvelle base de données vide, par exemple agorakit_testing et de vérifier dans le fichier phpunit.xml que tout correspond. | ||
|
||
Before comiting code, you should either write more tests (in this case you deserve a cookie). Or at least check that you didn't break anything by simply typing:: | ||
Avant de commencer le code, vous devriez soit écrire plus de tests (dans ce cas, vous méritez un cookie). Ou au moins vérifier que vous n'avez rien cassé en tapant simplement: : | ||
|
||
php artisan test | ||
|
||
...in the root of your project. | ||
...à la racine de votre projet. | ||
|
||
No error should appear (provided that you have everything correctly set up. | ||
Aucune erreur ne devrait apparaître (à condition que tout soit correctement configuré). | ||
|
||
We use travis ci to run all those tests on commit so it will be done automatically for you at some point :-) | ||
Nous utilisons travis ci pour exécuter tous ces tests lors du commit, donc cela sera fait automatiquement pour vous à un moment donné :-) | ||
|
||
# Writing tests | ||
# Ecriture des tests | ||
|
||
Don't hesitate to write tests. We favor well defined tasks an end user would really accomplish, like registering, creating an account, posting, uploading, etc... It has served us very well in the past to spot errors and it really mirrors real use cases. Although we are open to other kind of tests as well... | ||
N'hésitez pas à écrire des tests. Nous privilégions les tâches bien définies qu'un utilisateur final accomplirait réellement, comme l'inscription, la création d'un compte, la publication, le téléchargement, etc... Cela nous a très bien servi dans le passé pour repérer les erreurs et cela reflète vraiment les cas d'utilisation réels. Bien que nous soyons ouverts à d'autres types de tests... |
Oops, something went wrong.