Develop

For now Docker is a primary way of working on the repo.

Installation

Install virtualenv package if it's not installed.
```
pip install --user virtualenv
```
Create a virtual environment:
```
virtualenv venv
```

Activate the virtual environment.

#   Windows ➞ venv\Scripts\activate
source venv/bin/activate

Install python packages.

pip install --requirement requirements.txt

Install pre-commit hooks.
```
pre-commit install --install-hooks
```

Database

Register an account.
Visit http://localhost:5000/development
Click either seeded or random generation.

This will start a mock import process,
which will also populate the database.

Build

docker-compose build
docker-compose up --detach

In a browser, visit http://localhost:8000/

Manual

TODO : Write installation and setup instructions

This assumes you have Python 3.8+ & Node 12+ installed
as well as a running PostgreSQL server with Pgroonga.

#   Make sure your database is initialized
#   cd to kemono directory

pip install virtualenv
virtualenv venv

#   Windows ➞ venv\Scripts\activate
source venv/bin/activate

pip install \
    --requirement requirements.txt

cd client               \
    && npm install      \
    && npm run build    \
    && cd ..

Git

Configure git to store credentials:

git config credential.helper store

After the next time creds are accepted, they will be saved on hard drive as per rules listed in man git-credential-storeand won't be asked again.

Alternatively they can be stored temporarily in memory:

git config credential.helper cache

The creds are stored as per rules in man git-credential-cache.

IDE

IDE specific instructions.

VSCode

Copy .code-workspace file.

cp                                              \
    configs/workspace.code-workspace.example    \
    kemono-2.code-workspace

Install the recommended extensions.

2.3 KiB Raw Permalink Blame History Unescape Escape