Installation

🛠 Setup Instructions

1. Clone the main app

git clone https://github.com/kylevanderburg/minerva.git
cd minerva

2. Add the content repository (two options)

Option A: As a Git submodule (recommended)

git submodule add https://github.com/yourusername/minerva-content.git content
git submodule update --init --recursive

To update later:

cd content
git pull origin main

Option B: Manual clone

git clone https://github.com/yourusername/minerva-content.git content

And make sure /content is listed in .gitignore.


🔐 Authentication (Optional)

If config-users.json exists, Minerva will prompt for login on edit pages.

Example format:

{
  "yourusername": {
    "password": "$2y$10$hashedpasswordhere"
  }
}

Generate hashes with PHP:

echo password_hash('yourpassword', PASSWORD_DEFAULT);

⚙️ Configuration Notes

  • Content is loaded from the /content directory.
  • Markdown files are rendered using Parsedown.
  • Files are sorted naturally for chapter-like order.
  • Directory names act like "books".