Knitting Library — Manage your personal knitting…

Pitch

Description

Comments

About this project

Knitting Library offers a self-hosted platform for managing knitting patterns, projects, and yarn inventories. With features like searchable browsing, page annotation, and active project tracking, it's designed for knitters who wish to maintain control over their archives without relying on third-party services. Ideal for organizing PDFs, images, and notes in a user-friendly interface.

Knitting Library is a self-hosted management solution designed to give knitting enthusiasts control over their patterns, projects, and yarn inventory. Operating entirely within a single Docker container, this application keeps all data local, ensuring privacy and accessibility without the need for subscriptions or third-party services.

Key Features

Pattern Management: Upload PDF patterns and scanned images, accompanied by automatically generated thumbnails for easy reference.
Search and Browsing: Access patterns through a searchable interface that includes categories, tags, and project status filters for streamlined navigation.
Annotations and Tools: Annotate pages and utilize cleanup tools for images and recipe text versions, enhancing the clarity and usability of patterns.
Project Tracking: Keep track of both active and completed projects, allowing visibility for shared households.
Yarn Inventory Management: Organize yarn and thread references, manage color variants, stock levels, and even catalog tools and notions needed for knitting.
User Accounts and Security: Implement user accounts with optional two-factor authentication, individualized appearance settings, and administrative features for enhanced control.
Local Storage: Utilizes SQLite for data storage, with separate folders for data/ and logs/, ensuring easy management and backup options.

Current Status

Knitting Library is in active beta. It is functional in real-world scenarios, though some features and interfaces may undergo further development. Regular backups of the data/ folder are advisable, especially prior to updates to maintain safety and data integrity.

Security Considerations

The application includes several security measures, such as bcrypt password hashing, login rate limiting, CSRF protection, and upload validation. It is recommended to operate within a trusted network or VPN for increased security. While these measures aim to secure the application, a professional security audit has not been conducted.

Getting Started

To quickly launch the Knitting Library, users should deploy the application using Docker. Simply run the provided Docker commands to set up and access the user-friendly interface at http://localhost:3000.

Tech Stack

Built using FastAPI, React, Vite, SQLite, and Docker, Knitting Library offers a modern and responsive experience, suitable for both desktop and mobile usage.