How indentlabs/notebook works
Project type and purpose
• Notebook.ai is a full‐stack, monolithic Ruby on Rails web application providing both server‐rendered pages and a JSON API.
• Its goal is to help writers and roleplayers build and manage fictional universes via an interactive web interface, background processing (text analysis, machine learning hooks), and third‐party integrations (Stripe, PayPal, Slack, IBM Watson).
File structure
• Top‐level “app/” folder:
– app/controllers: Rails controllers including namespaced API controllers
– app/models: ActiveRecord models and concerns (business/domain logic)
– app/views: ERB templates for server‐rendered UI
– app/assets & app/javascript: asset‐pipeline (Sprockets) and Webpacker assets, JS components
– app/services: plain‐Ruby service objects encapsulating domain logic (e.g., document analysis, payment, autocomplete)
– app/jobs: background jobs (e.g., DocumentAnalysisJob)
• config/: Rails configuration, routes, cable (Action Cable), database, sidekiq/delayed_job, webpacker
• lib/: extensions, custom rake tasks
• bin/: startup scripts (rails server, delayed_job, webpack-dev-server)
• Dockerfile / docker-compose.yml: containerization
• spec/ & test/: automated tests
• README.rdoc: high‐level project description and deployment workflow
README for additional insights
• Confirms Rails stack, testing by rails test, deployment via staging/live with regression tests
• Emphasizes future extension areas: NLP services, ML name generators, knowledge graph