Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: update #428

Merged
merged 1 commit into from
Sep 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading