glenn
/
asteroid
mirror of https://github.com/glenneth1/asteroid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Update README.org file structure to reflect current project state

This commit is contained in:
glenneth 2025-10-12 06:35:08 +03:00 committed by Glenn Thompson
parent f101ff5757
commit cd02961a95
1 changed files with 66 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
README.org
View File

@ -61,29 +61,76 @@ Asteroid Radio is a complete internet radio streaming platform built with Common
asteroid/ asteroid/
├── asteroid.lisp # Main server with RADIANCE routes ├── asteroid.lisp # Main server with RADIANCE routes
├── asteroid.asd # System definition with dependencies ├── asteroid.asd # System definition with dependencies
├── stream-control.lisp # Stream queue management ├── asteroid # Compiled executable binary
├── user-management.lisp # User administration ├── module.lisp # RADIANCE module definition
├── playlist-management.lisp # Playlist operations ├── database.lisp # Database abstraction layer
├── test-server.sh # Automated test suite ├── auth-routes.lisp # Authentication and authorization routes
├── docker/ # Docker infrastructure ├── user-management.lisp # User management system
│ ├── docker-compose.yml # Container orchestration ├── users.lisp # User utilities
│ ├── asteroid-radio-docker.liq # Liquidsoap config ├── playlist-management.lisp # Playlist creation and management
│ ├── icecast.xml # Icecast configuration ├── stream-media.lisp # Media streaming functionality
│ └── music/ # Music library mount ├── app-utils.lisp # Application utilities
├── template-utils.lisp # Template rendering utilities
├── build-executable.lisp # Build script for binary
├── setup-environment.lisp # Environment setup script
├── asteroid-radio.liq # Liquidsoap streaming configuration
├── playlist.m3u # Generated playlist for streaming
├── Makefile # Build automation
├── template/ # CLIP HTML templates ├── template/ # CLIP HTML templates
│ ├── front-page.chtml # Main page with live stream │ ├── front-page.chtml # Main page with live stream
│ ├── admin.chtml # Admin dashboard │ ├── admin.chtml # Admin dashboard
│ ├── player.chtml # Web player interface │ ├── player.chtml # Web player interface
│ └── users.chtml # User management │ ├── login.chtml # User login page
├── static/ # CSS and assets │ ├── register.chtml # User registration page
│ └── asteroid.lass # LASS stylesheet │ ├── profile.chtml # User profile management
├── docs/ # Comprehensive documentation │ └── users.chtml # User management interface
│ ├── README.org # Documentation index ├── static/ # CSS, JavaScript, and assets
│ ├── PROJECT-OVERVIEW.org # Architecture overview │ ├── asteroid.lass # LASS stylesheet source
│ ├── PROJECT-HISTORY.org # Development timeline │ ├── asteroid.css # Compiled CSS
│ ├── INSTALLATION.org # Setup guide │ └── js/ # JavaScript modules
│ └── ... # Additional guides │ ├── admin.js # Admin panel functionality
└── music/ # Music library (local dev) │ ├── player.js # Audio player controls
│ ├── front-page.js # Front page interactions
│ ├── auth-ui.js # Authentication UI
│ ├── profile.js # Profile management
│ └── users.js # User management UI
├── config/ # Configuration files
│ └── radiance-postgres.lisp # PostgreSQL configuration
├── data/ # Runtime data
│ └── sessions/ # User session storage
├── docs/ # Documentation
│ ├── README.org # Documentation overview
│ ├── API-ENDPOINTS.org # API endpoint reference
│ ├── API-REFERENCE.org # Detailed API documentation
│ ├── DEVELOPMENT.org # Development guide
│ ├── INSTALLATION.org # Installation instructions
│ ├── TESTING.org # Testing documentation
│ ├── PROJECT-OVERVIEW.org # Project architecture overview
│ ├── POSTGRESQL-SETUP.org # Database setup guide
│ ├── DOCKER-STREAMING.org # Docker deployment guide
│ ├── PLAYLIST-SYSTEM.org # Playlist system documentation
│ ├── TRACK-PAGINATION-SYSTEM.org # Pagination documentation
│ └── USER-MANAGEMENT-SYSTEM.org # User system documentation
├── docker/ # Docker deployment
│ ├── docker-compose.yml # Docker Compose configuration
│ ├── Dockerfile.liquidsoap # Liquidsoap container
│ ├── asteroid-radio-docker.liq # Docker Liquidsoap config
│ ├── icecast.xml # Icecast configuration
│ ├── init-db.sql # Database initialization
│ ├── start.sh # Docker startup script
│ └── stop.sh # Docker shutdown script
├── music/ # Music library
│ ├── incoming/ # Upload staging area
│ └── library/ # Processed music files
├── test-server.sh # Server testing script
├── test-user-api.sh # User API testing script
├── run-all-tests.sh # Comprehensive test suite
├── comprehensive-performance-test.sh # Performance testing
├── analyze-performance.py # Performance analysis tool
├── simple-analysis.py # Simple analysis utilities
├── design.org # Design documentation
├── TODO.org # Project TODO list
└── project-summary.org # Project summary and status
#+END_SRC #+END_SRC
* Quick Start * Quick Start