aixsznt / README.md
hmtxj's picture
Update README.md
be0e7b7 verified
metadata
title: AI Novel Generator
emoji: πŸ“š
colorFrom: blue
colorTo: indigo
sdk: docker
app_port: 3000
pinned: false
license: mit

AI Novel Generator (Hugging Face Edition)

This is a Docker-based deployment of the AI Novel Generator on Hugging Face Spaces.

πŸš€ How to get started

  1. Deploy: The space is already running via Docker.
  2. Access: Just open the App tab!
  3. Configuration:
    • Go to Settings -> Variables and secrets
    • Add a Secret variable ENCRYPTION_KEY with a random string (e.g. my-secret-key-12345)
    • Add a Secret variable PORT set to 7860 (optional, HF sets this automatically but good to be explicit)

⚠️ Important Note on Data Persistence

On the free tier of Hugging Face Spaces, data is not persistent. Any novels you generate or configurations you save will be LOST if the Space restarts or sleeps.

To save your data permanently:

  1. Go to Settings -> Persistent Storage
  2. Upgrade your Space to a paid tier
  3. Mount a volume to /app/data

Features

  • πŸ€– AI Agent Workflow: Custom writing styles, CP templates, perspectives.
  • πŸš€ Concurrent Generation: Generate multiple novels at once.
  • πŸ“ Structured Writing: Title -> Outline -> Chapters.
  • πŸ”’ Privacy First: BYOK (Bring Your Own Key) architecture. Your API Key is stored in your browser.