TInventory

Inventory toolkit in order not to lose technology stuff anymore

Notice: This is a kind of software specially developed for the technology working group on Katharineum zu Lübeck. It's OK, of course, to use it for other purposes.

Installation instructions

Development system

1. Create virtual Python 3 environment in project directory $ python3 -m venv env
2. Activate virtual env $ source env/bin/activate
3. Install needed pip libraries by (env) $ pip install -r requirements.txt
4. Do migrations (env) $ python manage.py makemigrations && python manage.py migrate
5. Install yarn packages (ensure yarnpkg is installed) (env) $ python manage.py yarn install
6. Create first user (env) $ python manage.py createsuperuser
7. Run development server (env) $ python manage.py runserver

Production system using Docker

1. Install Docker
2. Install docker-compose
3. Go to project directory
4. Copy example.env to .env
5. Customize settings via editing .env
6. Run docker container
   • $ docker-compose up -f docker-compose.yml -f docker-compose.prod.yml (foreground)
   • $ docker-compose up -f docker-compose.yml -f docker-compose.prod.yml -d (background)

Testing docker system

Replace step 6 with following: 5. Run docker container - $ docker-compose up (foreground) - $ docker-compose up -d (background)

The difference is that the env vars for testing are predefined in docker-compose.override.yml and the tinventory image is going to be build live.

More information about Docker could be found on https://docker.com