Update: README.md
This commit is contained in:
parent
4d213e6c2b
commit
4a47655531
1 changed files with 67 additions and 1 deletions
68
README.md
68
README.md
|
@ -19,8 +19,74 @@ My try to make a Social media archiving web tool with django and gallery-dl
|
|||
- - - [X] Image (With HTML img tag)
|
||||
- - - [ ] other text documents
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
### Run without Docker
|
||||
|
||||
* **Step 1:** Clone repo
|
||||
```bash
|
||||
git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git
|
||||
```
|
||||
|
||||
* **Step 2:** Change dir to the new cloned repo
|
||||
```bash
|
||||
cd Gallery-Archivist
|
||||
```
|
||||
|
||||
* **Step 3:** Make a python environment
|
||||
```bash
|
||||
python3 -m venv venv
|
||||
```
|
||||
|
||||
* **Step 4:** Activate the new python environment
|
||||
```bash
|
||||
source ./venv/bin/activate
|
||||
```
|
||||
|
||||
* **Step 5:** Install python dependencies
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
* **Step 6:** Copy environment config file and change it to your liking
|
||||
```bash
|
||||
cp env-sample .env
|
||||
```
|
||||
|
||||
* **Step 7:** Change directory to `./archivist`
|
||||
```bash
|
||||
cd ./archivist
|
||||
```
|
||||
|
||||
* **Step 8:** Run django server
|
||||
```bash
|
||||
python3 manage.py runserver
|
||||
```
|
||||
|
||||
### Manual Import Data
|
||||
|
||||
It is possible to import data from saved gallery-dl json files
|
||||
|
||||
* **Step 1:** Make sure that you are in the root folder of the project.
|
||||
|
||||
* **Step 2:** Make sure to activate the python environment.
|
||||
```bash
|
||||
source ./venv/bin/activate
|
||||
```
|
||||
|
||||
* **Step 3:** Change directory to `./archivist`
|
||||
```bash
|
||||
cd ./archivist
|
||||
```
|
||||
|
||||
* **Step 4:** Import the json data and media file from gallery-dl
|
||||
replace `<path>` with the path of the folder or json file to import
|
||||
|
||||
```bash
|
||||
python manage.py import_data <path>
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
*Note!* Instructions are made for a modern linux environment.
|
||||
|
|
Loading…
Reference in a new issue