This commit is contained in:
parent
bbc2faeb7b
commit
6b5ccc2be6
5 changed files with 272 additions and 46 deletions
43
README.md
43
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# toolshed
|
||||
|
||||
## Installation / Development
|
||||
## Development
|
||||
|
||||
``` bash
|
||||
git clone https://github.com/gr4yj3d1/toolshed.git
|
||||
|
|
@ -12,7 +12,10 @@ or
|
|||
git clone https://git.neulandlabor.de/j3d1/toolshed.git
|
||||
```
|
||||
|
||||
### Backend
|
||||
all following development mode commands support auto-reloading and hot-reloading where applicable, they do not need to bw
|
||||
restarted after changes.
|
||||
|
||||
### Backend only
|
||||
|
||||
``` bash
|
||||
cd toolshed/backend
|
||||
|
|
@ -26,7 +29,7 @@ python manage.py runserver 0.0.0.0:8000 --insecure
|
|||
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
|
||||
### Frontend only
|
||||
|
||||
``` bash
|
||||
cd toolshed/frontend
|
||||
|
|
@ -34,13 +37,45 @@ npm install
|
|||
npm run dev
|
||||
```
|
||||
|
||||
### Docs
|
||||
### Docs only
|
||||
|
||||
``` bash
|
||||
cd toolshed/docs
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
### Full stack
|
||||
|
||||
``` bash
|
||||
cd toolshed
|
||||
docker-compose -f deploy/docker-compose.override.yml up --build
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
### Requirements
|
||||
|
||||
- python3
|
||||
- python3-pip
|
||||
- python3-venv
|
||||
- wget
|
||||
- unzip
|
||||
- nginx
|
||||
- uwsgi
|
||||
|
||||
### Installation
|
||||
|
||||
* Get the latest release from
|
||||
`https://git.neulandlabor.de/j3d1/toolshed/releases/download/<version>/toolshed.zip` or
|
||||
`https://github.com/gr4yj3d1/toolshed/archive/refs/tags/<version>.zip`.
|
||||
* Unpack it to `/var/www` or wherever you want to install toolshed.
|
||||
* Create a virtual environment and install the requirements.
|
||||
* Then run the configuration script.
|
||||
* Configure your webserver to serve the static files and proxy the requests to the backend.
|
||||
* Configure your webserver to run the backend with uwsgi.
|
||||
|
||||
for detailed instructions see [docs](/docs/deployment.md).
|
||||
|
||||
## CLI Client
|
||||
|
||||
### Requirements
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue