Fix: markdown styling

This commit is contained in:
Aroy-Art 2023-10-21 21:27:31 +02:00
parent 38f87fa61c
commit 8453a769ef
Signed by: Aroy
GPG key ID: DB9689E9391DD156

View file

@ -5,62 +5,71 @@
My try to make a Social media archiving web tool with django and gallery-dl My try to make a Social media archiving web tool with django and gallery-dl
## Features / Roadmap ## Features / Roadmap
*Note!* This is still in early development so stuff **will** change. *Note!* This is still in early development so stuff **will** change.
- - [ ] Scraping sites - [ ] Scraping sites
- - [ ] Scheduled tasks - [ ] Scheduled tasks
- - [ ] Site support - [ ] Site support
- - - [ ] [Furaffinity](https://www.furaffinity.net) - [ ] [Furaffinity](https://www.furaffinity.net)
- - - [ ] [Twitter/X](https://twitter.com/) - [ ] [Twitter/X](https://twitter.com/)
- - [ ] Media support and previews - [ ] Media support and previews
- - - [x] Flash (With [Ruffle](https://github.com/ruffle-rs/ruffle/)) - [x] Flash (With [Ruffle](https://github.com/ruffle-rs/ruffle/))
- - - [x] PDF (With HTML embed tag) - [x] PDF (With HTML embed tag)
- - - [X] Image (With HTML img tag) - [X] Image (With HTML img tag)
- - - [ ] other text documents - [ ] other text documents
--- ---
## Usage ## Usage
### Run without Docker ### Run without Docker
* **Step 1:** Clone repo - **Step 1:** Clone repo
```bash ```bash
git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git
``` ```
* **Step 2:** Change dir to the new cloned repo - **Step 2:** Change dir to the new cloned repo
```bash ```bash
cd Gallery-Archivist cd Gallery-Archivist
``` ```
* **Step 3:** Make a python environment - **Step 3:** Make a python environment
```bash ```bash
python3 -m venv venv python3 -m venv venv
``` ```
* **Step 4:** Activate the new python environment - **Step 4:** Activate the new python environment
```bash ```bash
source ./venv/bin/activate source ./venv/bin/activate
``` ```
* **Step 5:** Install python dependencies - **Step 5:** Install python dependencies
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
* **Step 6:** Copy environment config file and change it to your liking - **Step 6:** Copy environment config file and change it to your liking
```bash ```bash
cp env-sample .env cp env-sample .env
``` ```
* **Step 7:** Change directory to `./archivist` - **Step 7:** Change directory to `./archivist`
```bash ```bash
cd ./archivist cd ./archivist
``` ```
* **Step 8:** Run django server - **Step 8:** Run django server
```bash ```bash
python3 manage.py runserver python3 manage.py runserver
``` ```
@ -69,19 +78,21 @@ python3 manage.py runserver
It is possible to import data from saved gallery-dl json files 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 1:** Make sure that you are in the root folder of the project.
- **Step 2:** Make sure to activate the python environment.
* **Step 2:** Make sure to activate the python environment.
```bash ```bash
source ./venv/bin/activate source ./venv/bin/activate
``` ```
* **Step 3:** Change directory to `./archivist` - **Step 3:** Change directory to `./archivist`
```bash ```bash
cd ./archivist cd ./archivist
``` ```
* **Step 4:** Import the json data and media file from gallery-dl - **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 replace `<path>` with the path of the folder or json file to import
```bash ```bash
@ -90,39 +101,48 @@ python manage.py import_data <path>
## Development ## Development
### Without Docker
*Note!* Instructions are made for a modern linux environment. *Note!* Instructions are made for a modern linux environment.
* **Step 1:** Clone repo - **Step 1:** Clone repo
```bash ```bash
git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git
``` ```
* **Step 2:** Change dir to the new cloned repo - **Step 2:** Change dir to the new cloned repo
```bash ```bash
cd Gallery-Archivist cd Gallery-Archivist
``` ```
* **Step 3:** Make a python environment - **Step 3:** Make a python environment
```bash ```bash
python3 -m venv venv python3 -m venv venv
``` ```
* **Step 4:** Activate the new python environment - **Step 4:** Activate the new python environment
```bash ```bash
source ./venv/bin/activate source ./venv/bin/activate
``` ```
* **Step 5:** Install python dependencies - **Step 5:** Install python dependencies
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
* **Step 6:** Copy environment config file and change it to your liking - **Step 6:** Copy environment config file and change it to your liking
```bash ```bash
cp env-sample .env cp env-sample .env
``` ```
* **Step 7:** Run django server - **Step 7:** Run django server
```bash ```bash
python3 archivist/manage.py runserver python3 archivist/manage.py runserver
``` ```