ChaoticByte/drinks-manager
1
1
Fork 0
Code Issues Pull requests Projects Releases 20 Packages Wiki Activity Actions

Removed the command 'run-script' and added the command 'shell', and updated the docs and README

Browse source
This commit is contained in:
W13R 2022-04-18 17:00:12 +02:00
parent a9c5ec34fc
commit aa85ac5ffc
5 changed files with 38 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

33
docs/Commands.md
View file

@ -10,55 +10,60 @@ You run a command with
---
`server` - Start the server
This starts a caddy instance, uvicorn with the django application and a scheduler that automatically removes expired session data.
### `server`
This starts the application (a caddy instance, uvicorn with the Django application and a scheduler that automatically removes expired session data).
Log files will be written.
---
`setup` - Set up the application
### `setup`
This sets up some database tables, views, and more, generates a secret key for the application and lets you create an admin user.
---
`create-admin` - Lets you create an admin user
### `create-admin`
Lets you create an admin user
---
`generate-secret-key` - generate a new random secret key for django
### `generate-secret-key`
Generate a new random secret key for Django.
This will overwrite the old one.
Warning: After running this, current sessions will be invalid, and the users have to relogin. Don't run this command while the server is running.
---
`clear-sessions` - manually remove all expired sessions from the database
### `clear-sessions`
manually remove all expired sessions from the database
---
`force-db-upgrade` - force a database migration and -upgrade
### `force-db-upgrade`
force a database migration and -upgrade.
This is mainly used in development.
---
`archive-tables` - archive (copy & delete) all entries in app_order and app_registertransaction
### `archive-tables`
archive (copy & delete) all entries in app_order and app_registertransaction.
Use this to archive old orders or transactions (e.g. when the database gets too big).
---
`development-server` - Start the development server
This starts a caddy instance, the django development server with DEBUGGING enabled and the session-clear-scheduler.
### `development-server`
This starts a caddy instance, the Django development server with DEBUGGING enabled and the session-clear-scheduler.
Only the HTTP-Access-Log will be written to its logfile, other logs will be written to the console.
---
`run-script <path>` - Run a python script in the context of the django project (experimental)
`<path>` is the path to the python script
### `shell`
Keep in mind that the current directory won't be changed automatically to the parent folder of the script file.
Start a Django shell.
---
`help` - Show a help text
### `help`
Show a help text
---