elf-audio / koala-documentation

Koala - Documentation

Project functions

Run the project

Run the project in developing mode.

bundle exec jekyll serve

Build the project

Build the project.

bundle exec jekyll build

Mine images from PSD files

The application parses images from canvases/mobile.psd and canvases/tablet.psd files.

canvases/mobile.example.psd and canvases/tablet.example.psd files are used as examples. Create your own PSDs based on them. If you get any unexpected results just compare your and example PSDs.

The script generates images/mobile-file-list.txt and images/tablet-file-list.txt files with lists of paths to generated files.

For instance,

----------------------
images/2/tablet/IMG_8151|serform
images/2/tablet/IMG_8150|sequence
images/2/tablet/IMG_8148|sample
----------------------
images/3/tablet/IMG_8153|copy

Mine your PSD!

Images add into the images/ folder.

python mine-psd.py

Set up working environment

Prepare your working space to start working on.

Python

1. Initiate a fresh Python virtual environment if it does not exist yet.

python -m venv venv

OR

python3 -m venv venv

2. Activate a Python's environment

source venv/bin/activate

3. Install dependencies

pip install -r requirements.txt

Ruby

1. Select a project's ruby version which is in the .ruby-version file.

rvm use

2. Install dependencies.

bundle install

Install Ruby

If you need to install Ruby and encounter different troubles along the way then you should look at the recommendations below.

---

Install ruby using rvm.

---

Solutions to potentials problems

Installation ruby via rvm generates the next error.

Error running '__rvm_make -j16',
please read /home/stas/.rvm/log/1692449785_ruby-3.0.0/make.log

There has been an error while running make. Halting the installation.

Point OpenSSL during installation

---

Running bundle raises an OpenSSL error.

Could not load OpenSSL.
You must recompile Ruby with OpenSSL support or change the sources in your Gemfile from 'https' to 'http'. Instructions for compiling with OpenSSL
using RVM are available at rvm.io/packages/openssl.

Reinstall Ruby pointing OpenSSL during the installation

rvm reinstall 3.1.4 --with-openssl-dir=/usr/bin/openssl

Reinstall Ruby with disabled "autolibs"

rvm install 3.14 --autolibs=disable

---

RVM is not a function, selecting rubies with 'rvm use ...' will not work

Run shell in a login shell mode