Add server startup commands to project documentation

- Include command-line and REPL startup instructions
- Document available server management functions
- Provide clear examples for both development and production use
This commit is contained in:
Glenn Thompson 2025-08-20 08:44:15 +03:00 committed by Brian O'Reilly
parent 4bb1b1697a
commit 4f399b95fa
1 changed files with 27 additions and 0 deletions

View File

@ -158,6 +158,33 @@ Used single quotes instead of double quotes for SBCL command-line arguments to p
- Responsive web interface
- Server management functions exported
** 🚀 Running the Server
*** Command Line (One-shot execution)
#+BEGIN_EXAMPLE
sbcl --eval '(ql:quickload (quote (:hunchentoot :spinneret :cl-json)))' \
--eval '(load "asteroid.asd")' \
--eval '(asdf:load-system :asteroid)' \
--eval '(asteroid:start-server)' \
--eval '(format t "Server running at http://localhost:8080 - Press Ctrl+C to stop")'
#+END_EXAMPLE
*** Interactive REPL
#+BEGIN_EXAMPLE
sbcl
(ql:quickload '(:hunchentoot :spinneret :cl-json))
(load "asteroid.asd")
(asdf:load-system :asteroid)
(asteroid:start-server)
;; Server now running at http://localhost:8080
;; To stop: (asteroid:stop-server)
#+END_EXAMPLE
*** Available Functions
- =(asteroid:start-server)= - Start web server (non-blocking)
- =(asteroid:stop-server)= - Stop web server cleanly
- =(asteroid:run-server)= - Start server and keep running (blocking, with Ctrl+C handler)
** 📋 Next Steps (Not Implemented)
- Database integration (when MITO alternative chosen)
- Audio streaming backend (Liquidsoap integration)