This commit is contained in:
parent
bbc2faeb7b
commit
6b5ccc2be6
5 changed files with 272 additions and 46 deletions
|
|
@ -6,47 +6,8 @@ This is the documentation for the Toolshed project. It is a work in progress.
|
|||
`#social` `#network` `#federation` `#decentralized` `#federated` `#socialnetwork` `#fediverse` `#community` `#hashtags`
|
||||
|
||||
## Getting Started
|
||||
- [Deploying Toolshed](deployment.md)
|
||||
- [Development Setup](development.md)
|
||||
- [About Federation](federation.md)
|
||||
|
||||
## Installation
|
||||
|
||||
``` bash
|
||||
# TODO add installation instructions
|
||||
# similar to development instructions just with more docker
|
||||
# TODO add docker-compose.yml
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
``` bash
|
||||
git clone https://github.com/gr4yj3d1/toolshed.git
|
||||
```
|
||||
or
|
||||
``` bash
|
||||
git clone https://git.neulandlabor.de/j3d1/toolshed.git
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
``` bash
|
||||
cd toolshed/frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Backend
|
||||
|
||||
``` bash
|
||||
cd toolshed/backend
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
python manage.py migrate
|
||||
python manage.py runserver 0.0.0.0:8000
|
||||
```
|
||||
|
||||
### Docs
|
||||
|
||||
``` bash
|
||||
cd toolshed/docs
|
||||
mkdocs serve -a 0.0.0.0:8080
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue