Skip to content

Latest commit

 

History

History
216 lines (159 loc) · 8.09 KB

README.md

File metadata and controls

216 lines (159 loc) · 8.09 KB
Raw

Kirppu – Second-hand sales POS and vendor signup for conventions

Test

Getting development started using Docker

Install Docker and docker-compose plugin and run

docker compose up

Getting development started without Docker

This guide is meant for setting up a basic Kirppu development environment for testing. It consists of a high level guide outlining the steps, example guide that has more detail and finally some pointers on how to access Kirppu once it's running.

High level guide

  1. Install Python >= 3.11.
  2. Clone Kirppu.
  3. Create virtualenv.
  4. Install dependencies with pip and requirements-dev.txt
  5. Install js dependencies with npm (in kirppu sub-folder).
  6. Setup database with dev data.
  7. Run gulp to build frontend code.
  8. Run django with manage.py.

Example guide

Windows:

  • If pip or virtualenv are missing from PATH, even though they are installed, call them through python
    • python -m pip install virtualenv
    • python -m virtualenv venv

Syntax:

  • # comment
  • $ Linux/generic command line
  • > Windows specific command line

Setting up Kirppu and its dependencies

# Install python if your system doesn't have it already.
$ sudo aptitude install python

# Install pip. If using Windows, check pip website for how to install pip.
$ sudo aptitude install python-pip
$ sudo pip install virtualenv
$ git clone https://github.com/jlaunonen/kirppu.git kirppu
$ cd kirppu

# Activate virtualenv. After this point all modules installed with pip
# are local to the project.
~/kirppu$ source venv/bin/activate
> venv\Scripts\activate.bat

# (optional) Check that python and pip point to the venv folder.
(venv) ~/kirppu$ which python pip
/home/ari/kirppu/venv/bin/python
/home/ari/kirppu/venv/bin/pip

# Install packages needed to build the requirements from source.
# On Windows pip might download actual binaries, or you might need to
# have Visual Studio and install the dependencies
# Pillow/PIL can make use of other libs too, but zlib should suffice.
sudo aptitude install python-dev zlib1g-dev nodejs
sudo yum install python-devel libzip-devel nodejs

# Install required python packages.
~/kirppu$ pip install -r requirements-dev.txt
Successfully installed django-1.6.10 django-pipeline-1.3.27 pillow-2.4.0 pyBarcode-0.8b1

# Install required js packages (defined by package.json).
# Note, that this is ran inside the "kirppu" module instead of project root.
~/kirppu/kirppu$ npm install
# (this may take a while, and will output huge tree after it completes.)

# Build frontend.
~/kirppu/kirppu$ npm run gulp -- --mode debug

Add some example Data for Kirppu.

# Avoid having to define SECRET_KEY & co
(venv) ~/kirppu$ export DEBUG=1

# Initialize models for Kirppu in a sqlite database (db.sqlite).
# Create a new superuser when asked.
(venv) ~/kirppu$ python manage.py migrate
Installed 0 object(s) from 0 fixture(s)

# Load some fake data to play with.
(venv) ~/kirppu$ python manage.py loaddata dev_data default_text groups default_types
Installed 10 object(s) from 1 fixture(s)

# Run Django dev server in some port, I like 9874.
(venv) ~/kirppu$ python manage.py runserver 9874

Testing Kirppu

Install the dependencies from requirements-dev.txt. You can then run unit tests with

py.test -vvv --cov . --doctest-modules
  • Set DEBUG=1 environment variable, OR copy .env.dev file to .env, OR set ENV_PATH environment variable to point to correct env file.
  • Admin interface
    • localhost:9874/admin/
    • Login with the local superuser credentials.
    • You can view and modify the model at your will here.
  • Vendor UI
    • localhost:9874/kirppu/default/vendor
    • Vendors register their items here.
  • Clerk UI
    • localhost:9874/kirppu/default/checkout
    • "Locked Need to validate counter."
      • Input :*dev_counter
    • "Locked Login..."
      • In admin panel, goto clerks and generate an access code for you self with Action: "Generate missing Clerk access codes"
      • Input your access code. Alternatively, add KIRPPU_AUTO_CLERK = "*" to kirppu_project/local_settings.py or env file.

Updating dependencies

Within your virtualenv where you have pip-tools (e.g. from requirements-dev.txt) installed,

  1. (optional) Alter pyproject.toml.
  2. Run make update-constraints to upgrade package version constraints.txt for total dependency tree.
  3. Run make requirement-sets to upgrade plain trees of different sets (dev / production).

Frontend development notes

To compile frontend sources for use in browser, there is two choices, which can both be added to IDE simultaneously.

Gulp watcher

  • When changing files in static_src, they need to be compiled with gulp. Manually (note directory):

    • ~/kirppu/kirppu$ node node_modules/gulp/bin/gulp.js
    • or ~/kirppu/kirppu/$ npm run gulp

  • Gulp can automatically build the changed files with its watcher. It does not, however handle file additions, pipeline changes, nor gulpfile changes. For those changes, manual rebuild must be done and the watcher then restarted.

    • ~/kirppu/kirppu$ npm run gulp watch

  • Alternatively, automatic compilation can be added to IDE. Following configuration compiles only module whose part has been changed.

    • Disable Immediate file synchronization
    • Show console: Always (errors are currently not found correctly from output)
    • File type: Any
    • Scope: Define own scope that recursively contains static_src directory.
    • Program: Either node_modules/gulp/bin/gulp.js or wrapper script (or node itself; add the gulp.js to first argument then).
    • Arguments: build --file $FilePathRelativeToProjectRoot$
    • Output paths to refresh: ./static

  • When needed, automatic compilation can be disabled from watcher list by un-checking the watcher.

Gulp run configuration

  • "Rebuild":

    • Gulpfile: Choose the gulpfile.js from kirppu module.
    • Task: default
    • Node: Choose your node binary.
    • Gulp package: Find kirppu/kirppu/node_modules/gulp.

  • "Rebuild production":

    • Same as above, but this additionally compress the results (of some parts). This will take a bit longer than without compress.
    • Arguments: --type production

MIT License

The MIT License (MIT)

Copyright (c) 2013 Jyrki Launonen
Copyright (c) 2014 Ari Koivula, Jyrki Launonen, Elina Lukkarinen, Arttu Ylä-Outinen
Copyright (c) 2015 Mikko Karttunen, Ari Koivula, Aarni Koskela, Jyrki Launonen, Juha Lepola, Mikael Niemelä, Arttu Ylä-Outinen
Copyright (c) 2014–2017 Santtu Pajukanta
Copyright (c) 2016 Aarni Koskela, Jyrki Launonen
Copyright (c) 2017 Jyrki Launonen
Copyright (c) 2018 Aarni Koskela, Jyrki Launonen
Copyright (c) 2019 Jyrki Launonen
Copyright (c) 2020 Aarni Koskela, Jyrki Launonen
Copyright (c) 2021 Jyrki Launonen
Copyright (c) 2022 Jyrki Launonen
Copyright (c) 2023 Jyrki Launonen
Copyright (c) 2024 Jyrki Launonen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.