From 20a93639ffba5953fc95d8b681b63b681a2935c1 Mon Sep 17 00:00:00 2001 From: jedi Date: Wed, 8 Mar 2023 09:25:51 +0100 Subject: [PATCH] rename pycharm project --- README.md | 46 +++------------------------------------------- 1 file changed, 3 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 854b54b..c60518c 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,13 @@ # toolshed -## Installation / Development +## Installation ``` bash git clone https://github.com/gr4yj3d1/toolshed.git -``` -or -``` bash -git clone https://git.neulandlabor.de/j3d1/toolshed.git -``` - -### Backend - -``` bash cd toolshed/backend python3 -m venv venv source venv/bin/activate pip install -r requirements.txt -python configure.py -python manage.py runserver 0.0.0.0:8000 --insecure +python manage.py migrate +python manage.py runserver ``` -to run this in properly in production, you need to configure a webserver to serve the static files and proxy the requests to the backend, then run the backend with just `python manage.py runserver` without the `--insecure` flag. - -### Frontend - -``` bash -cd toolshed/frontend -npm install -npm run dev -``` - -### Docs - -``` bash -cd toolshed/docs -mkdocs serve -``` - - - -## CLI Client - -### Requirements - -- python3 -- python3-nacl - -### Usage Example - -``` bash -cli-client/toolshed-client.py --key --user name@example.com --host 1.2.3.4:8000 getinventory -``` \ No newline at end of file