From bfb1076b135b53bc235e93f8709b024167a02b2e Mon Sep 17 00:00:00 2001 From: aldrin Date: Tue, 26 Oct 2021 13:48:15 +0200 Subject: [PATCH] fix: Adapt README to current dev setup --- README.md | 55 +++++++++++++++++++++++++------------------------------ 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1d7696a..d28ef3e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,31 @@ -# userausfall +# Userausfall -## Backend: Development server +User account management for systemausfall.org + +## Quick Development Setup + +Bootstrap your venv and project (you’ll need to do this only once): ```shell -export DJANGO_SETTINGS_MODULE=userausfall.settings USERAUSFALL_SECRET_KEY=dev +# Create a virtual environment +python3 -m venv --system-site-packages venv +# Activate your venv +. venv/bin/activate +# Install dependencies +pip install --editable . +``` + +In the future just run: +```shell +# Activate your venv +. venv/bin/activate +# Configure the settings +export DJANGO_SETTINGS_MODULE=userausfall.settings +# Apply database migrations python3 -m django migrate +``` + +Start the API development server with: +```shell python3 -m django runserver ``` - -## Frontend: Project setup -``` -npm install -``` - -### Compiles and hot-reloads for development -``` -npm run serve -``` - -### Compiles and minifies for production -``` -npm run build -``` - -### Lints and fixes files -``` -npm run lint -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). - -## Credits - -* Parts of initial code are based on [schnipsel](https://git.hack-hro.de/kmohrf/schnipsel). \ No newline at end of file