Skip to content

Commit 1374b41

Browse files
initial server integration
1 parent 982758e commit 1374b41

14 files changed

Lines changed: 2645 additions & 12 deletions

File tree

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ ignore
1010
LiaScript
1111
node_modules
1212
scripts
13+
server
1314
*.zip
1415
ignore

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,51 @@ sudo npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
6767

6868
On Windows you might need to run the terminal with administrator-privileges.
6969

70+
### Web Server Mode
71+
72+
Instead of command-line exports, you can also start a web server with a user-friendly interface:
73+
74+
``` bash
75+
$ liaex serve
76+
```
77+
78+
This starts the LiaScript Export Server on port 3000 (default). You can specify a different port:
79+
80+
``` bash
81+
$ liaex serve --port 8080
82+
```
83+
84+
The web interface allows you to:
85+
86+
- **Upload files** or specify a **Git repository** as your project source
87+
- Select an **export target** (Moodle, ILIAS, OPAL, Generic LMS, Web, PDF)
88+
- Configure **advanced settings** for your export
89+
- Queue export jobs and track their status
90+
91+
All exports are processed asynchronously in a queue, with only one export running at a time. After submitting an export, you'll receive a job ID and can track the progress on a status page.
92+
93+
**Features:**
94+
- Multi-user support with job queue
95+
- File upload (ZIP or multiple files)
96+
- Git repository support (with branch/subdirectory options)
97+
- Preset-based export targets for common LMS platforms
98+
- Manual format selection (SCORM 1.2, SCORM 2004, IMS, Web, PDF, Android, JSON)
99+
- Status tracking for export jobs
100+
101+
The server mode is perfect for:
102+
- Non-technical users who prefer a GUI
103+
- Institutions that want to provide a self-service export solution
104+
- Batch processing of multiple courses
105+
- Testing different export configurations
106+
70107
## Basic CLI usage
71108

72109
If you have installed the package, you can now use `liaex` or
73110
`liascript-exporter`. If you type one of the following commands, you will get
74111
the following output.
75112

113+
### Command-line Export
114+
76115
``` shell
77116
$ liaex
78117
No input defined

dist/index.js

Lines changed: 17 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)