j3d1/toolshed
1
0
Fork 0
Code Issues 9 Pull requests 1 Projects Releases Packages Wiki Activity

rename pycharm project

Browse source
This commit is contained in:
j3d1 2023-03-08 09:25:51 +01:00
parent e447f389d8
commit 20a93639ff
1 changed files with 3 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -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 <hex private key> --user name@example.com --host 1.2.3.4:8000 getinventory
```