Skip to content

Commit

Permalink
README: update
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentporte committed Sep 26, 2023
1 parent a36a2ac commit 7e35221
Showing 1 changed file with 10 additions and 27 deletions.
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
# La communauté de l'inclusion

## Initial setup
## Initial dev setup

Installer l'environnement virtuel et les dépendances :

```bash
$ poetry install
```

Creer les buckets S3 :

```bash
s3cmd mb s3://test-inclusion-public/
s3cmd setacl s3://test-inclusion-public/ --acl-public
s3cmd mb s3://test-inclusion-private/
```

Copier le fichier `.env.template` en `.env` et le modifier en fonction de vos besoins.

```bash
Expand All @@ -33,53 +25,44 @@ $ poetry shell
Démarer la base de données

```bash
$ docker-compose up -d
$ docker-compose up postgres -d
```

Démarrer le service web

```bash
python manage.py runserver
$ python manage.py runserver
```

## Peupler la base de données

1. setup anonymous user default perms
1. setup authenticated user default perms
1. creer un forum type=0, kind=PUBLIC_FORUM, name="Échanges"
1. creer un forum type=0, kind=News, name="Actualités"

pour créer de la documentation:

1. creer un forum type=1, kind=PUBLIC_FORUM, name="nom du thème"
1. creer un à x forum(s) type=0, kind=PUBLIC_FORUM, parent={forum précédent}, name="nom du sous-thème"

```bash
$ python manage.py loaddata fixtures/validation_fixtures.json
```
## Mises à jour

Ajouter d'une dépendance :

```bash
poetry add django-anymail
$ poetry add django-anymail
```

Ajouter d'une dépendance de développement :

```bash
poetry add --group dev poethepoet
$ poetry add --group dev poethepoet
```

Mettre à jour des dépendances :

```bash
poetry update
poetry lock
$ poetry update;poetry lock
```

Générer les fichiers `requirements`

```bash
poetry run poe export
poetry run poe export_dev
$ poetry run poe export;poetry run poe export_dev
```

## Développement
Expand Down

0 comments on commit 7e35221

Please sign in to comment.