systemausfall.org/userausfall
Archived
5
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix: Adapt README to current dev setup

Browse source
This commit is contained in:
aldrin 2021-10-26 13:48:15 +02:00
parent 8ca0f66777
commit bfb1076b13
1 changed files with 25 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -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).