2023-03-08 08:25:51 +00:00
|
|
|
# toolshed
|
|
|
|
|
|
2023-06-11 08:46:11 +00:00
|
|
|
## Installation / Development
|
2023-03-08 08:25:51 +00:00
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
git clone https://github.com/gr4yj3d1/toolshed.git
|
2023-06-11 08:46:11 +00:00
|
|
|
```
|
2023-07-07 16:45:05 +00:00
|
|
|
|
2023-06-11 08:46:11 +00:00
|
|
|
or
|
2023-07-07 16:45:05 +00:00
|
|
|
|
2023-06-11 08:46:11 +00:00
|
|
|
``` bash
|
|
|
|
|
git clone https://git.neulandlabor.de/j3d1/toolshed.git
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Backend
|
|
|
|
|
|
|
|
|
|
``` bash
|
2023-03-08 08:25:51 +00:00
|
|
|
cd toolshed/backend
|
|
|
|
|
python3 -m venv venv
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
pip install -r requirements.txt
|
2023-06-11 08:46:11 +00:00
|
|
|
python configure.py
|
2023-06-22 02:08:52 +00:00
|
|
|
python manage.py runserver 0.0.0.0:8000 --insecure
|
2023-06-11 08:46:11 +00:00
|
|
|
```
|
2023-07-07 16:45:05 +00:00
|
|
|
|
|
|
|
|
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.
|
2023-06-11 08:46:11 +00:00
|
|
|
|
|
|
|
|
### Frontend
|
|
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
cd toolshed/frontend
|
|
|
|
|
npm install
|
|
|
|
|
npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Docs
|
|
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
cd toolshed/docs
|
|
|
|
|
mkdocs serve
|
2023-03-08 08:25:51 +00:00
|
|
|
```
|
2023-06-11 08:46:11 +00:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
```
|
