Skip to content

Create Kanban supply cards for your home

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE
Unknown
COPYING
Notifications You must be signed in to change notification settings

fergbrain/kanban_household_supply_card_generator

Repository files navigation

Kanban Household Supply Card Generator

Background

I was watching a video on using Kanban for your pantry and thought it was a great idea.

There's a couple more videos you can watch as well:

  1. Kanban Pantry 2
  2. Kanban @ Home

I couldn't find a tool that would let me easily create the cards I thought I needed, so I made one.

What it is

This tool lets you create Kanban supply cards (and labels) for your home. Items are generated as a PDF so you can easily print them. Cards print on standard 3x5 cards. Labels print on an 8.5x11 sheet that you can cutout.

Designed to run on localhost for now. Very much alpha, but it works and we use it at home.

Add items/suppliers/locations: http://localhost:8000/admin/

Generate all cards: http://localhost:8000/generate/card/

Generate an individual card: http://localhost:8000//generate/card/<id>/

Generate shelf labels: http://localhost:8000//generate/shelf/

Built with Cookiecutter Django Black code style
License:Affero GPLv3

Examples

Kanban Supply Card Example

Example Kanban Card

Kanban Supply Card Example

Example of shelf labels

Adding an Item

Screenshot of the add/change item screen

Adding a Location

Screenshot of the add/change location screen

Adding a Supplier

Screenshot of the add/change supplier screen

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

  • To create an superuser account, use this command:

    $ python manage.py createsuperuser
    

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy kanban_household_supply_card_generator

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Deployment

The following details how to deploy this application.

About

Create Kanban supply cards for your home

Resources

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE
Unknown
COPYING

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published