Skip to content

Jinbocho Manuals

Complete documentation for Jinbocho: Home Library Management System.

What You'll Find Here

This directory contains two comprehensive manuals:

👨‍💻 Developer Manual

For developers, DevOps engineers, and maintainers who need to: - Set up local development environment - Deploy Jinbocho to production (Render + Neon) - Understand system architecture - Troubleshoot deployment issues

Key sections: - Prerequisites (Docker, Python, Node.js) - Local development with Docker Compose - Backend services overview - CI/CD and GitHub Actions - Production deployment guide - Monitoring, logging, troubleshooting

Time to read: ~2-3 hours for a complete understanding

👥 User Manual

For end-users and family members who want to: - Create an account and get started - Add and organize books - Search and filter your library - Invite family members - Track reading progress

Key sections: - Getting started and account creation - Authentication and account management - Adding and managing books - Organizing locations (rooms, bookcases, shelves) - Advanced features (scanning, export, bulk operations) - Family management and user roles - Mobile tips and localization

Time to read: ~1-2 hours to learn all features

Quick Start

For Developers

  1. Start here: Developer Manual → Prerequisites
  2. Then: Local Development Setup
  3. You'll have a full local environment running in 15 minutes

For Users

  1. Start here: User Manual → Getting Started
  2. Then: Authentication & Accounts
  3. Follow the in-app guides for your first actions

Browse by Topic

Setting Up Locally (Developers) - System requirements: Prerequisites - Local environment: Local Development

Getting Started (Users) - Create your account: Getting Started - Understand login & security: Authentication

Using Jinbocho (Users) - Add books: Core Features (coming soon) - Organize rooms/bookcases: Core Features (coming soon) - Search and filter: Core Features (coming soon)

Deploying to Production (Developers) - Render + Neon setup: Production Deployment (coming soon) - CI/CD pipelines: CI/CD Setup (coming soon) - Monitoring: Monitoring & Logging (coming soon)

Contributing

If you find: - ❌ Outdated information - 🤔 Unclear instructions - 🐛 Broken links - ✨ Missing documentation

Please:

  • Report on GitHub Issues
  • Email jinbochoapp@gmail.com
  • Submit a PR with fixes

Resources

  • Render: https://render.com
  • Neon: https://neon.tech
  • Docker: https://docker.com