Change return; Add DEVELOPMENT.md

1 files changed, 42 insertions, 0 deletions

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 00000000..bae55af9
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,42 @@
+# Various development notes
+
+## Backend
+
+Use the doc in the README.md
+
+Run server with:
+
+```shell
+export AUTHLIB_INSECURE_TRANSPORT=1
+export FLASK_ENV=development
+flask run
+```
+
+All ActivityPub code (inbound or outbound) needs to have the celery worker running.
+
+## Unittests (backend)
+
+```shell
+export CONFIGTEST=configtest.py
+pytest
+```
+
+## Unittests (frontend)
+
+None yet
+
+## Frontend
+
+Create `front/config/local.json` with:
+
+```json
+{
+  "target": "http://127.0.0.1:5000/"
+}
+```
+
+Run the front with: `cd front && npm run dev`
+
+Then access to the front on: http://localhost:8081
+
+The backend will be automatically proxified.