codemunkeh/AudioCore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
codemunkeh
2026-03-04 21:43:18 +00:00
parent d5677b2457
commit 72b76397ef
1 changed files with 46 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -1,47 +1,46 @@
+# AudioCore V1.5 # AudioCore V1.5
+
+AudioCore V1.5 is a modular CMS for labels, artists, releases, storefront sales, and support workflows. AudioCore V1.5 is a modular CMS for labels, artists, releases, storefront sales, and support workflows.
+
+It is built around a plugin-first architecture so core stays clean while features can be enabled/disabled per site. It is built around a plugin-first architecture so core stays clean while features can be enabled/disabled per site.
+
+## Key features ## Key features
+
+- Modular plugin system (enable/disable from admin) - Modular plugin system (enable/disable from admin)
+- Artists plugin (profiles, socials, artist pages) - Artists plugin (profiles, socials, artist pages)
+- Releases plugin (catalog pages, release detail, track metadata, samples) - Releases plugin (catalog pages, release detail, track metadata, samples)
+- Store plugin (cart, checkout, PayPal, orders, customers, discounts, downloads) - Store plugin (cart, checkout, PayPal, orders, customers, discounts, downloads)
+- Support plugin (ticketing, IMAP reply sync, admin replies) - Support plugin (ticketing, IMAP reply sync, admin replies)
+- Newsletter module (subscriber management + templates) - Newsletter module (subscriber management + templates)
+- Media library (upload and reuse media across modules) - Media library (upload and reuse media across modules)
+- Page builder + shortcode support - Page builder + shortcode support
+- Maintenance/coming-soon controls - Maintenance/coming-soon controls
+- Update checker from Gitea manifest - Update checker from Gitea manifest
+
+## Tech overview ## Tech overview
+
+- PHP 8.3+ - PHP 8.3+
+- MySQL/MariaDB - MySQL/MariaDB
+- OpenLiteSpeed/Apache compatible routing via `.htaccess` - OpenLiteSpeed/Apache compatible routing via `.htaccess`
+- Server cron integration for background jobs (IMAP sync, chart refresh) - Server cron integration for background jobs (IMAP sync, chart refresh)
+
+## Install (high level) ## Install (high level)
+
+1. Upload project files. 1. Upload project files.
+2. Point web root to `dev/` (or deploy repo to desired root). 2. Point web root to `dev/` (or deploy repo to desired root).
+3. Open `/admin` to run installer. 3. Open `/admin` to run installer.
+4. Enter database + admin details. 4. Enter database + admin details.
+5. Configure SMTP and run test email. 5. Configure SMTP and run test email.
+6. Enable required plugins and create their tables. 6. Enable required plugins and create their tables.
+
+## Recommended production setup ## Recommended production setup
+
+- Keep private download storage outside public web root. - Keep private download storage outside public web root.
+- Use HTTPS only. - Use HTTPS only.
+- Configure SMTP correctly for transactional mail. - Configure SMTP correctly for transactional mail.
+- Configure cron jobs in Admin > Cron Jobs. - Configure cron jobs in Admin > Cron Jobs.
+- Keep `storage/` writable and secured. - Keep `storage/` writable and secured.
+
+## Release notes source ## Release notes source
+
+Updates are controlled via `update.json` in this repository and checked from admin Updates page. Updates are controlled via `update.json` in this repository and checked from admin Updates page.
+