docs: add README with setup instructions and API endpoints
This commit is contained in:
33
readme.md
33
readme.md
@@ -0,0 +1,33 @@
|
|||||||
|
|
||||||
|
# Moodle Timetable Server
|
||||||
|
|
||||||
|
A Node.js server that fetches timetable data from WebUntis.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Install dependencies:
|
||||||
|
```bash
|
||||||
|
npm install express dotenv luxon webuntis
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a `.env` file with:
|
||||||
|
```env
|
||||||
|
PORT=3000
|
||||||
|
WEBUNTIS_SCHOOL=your_school
|
||||||
|
WEBUNTIS_USER=your_username
|
||||||
|
WEBUNTIS_PASS=your_password
|
||||||
|
WEBUNTIS_URL=your_webuntis_url
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Endpoints
|
||||||
|
|
||||||
|
- `GET /` - Health check
|
||||||
|
- `GET /timetable` - Fetch timetable for next 4 weeks
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node server.js
|
||||||
|
```
|
||||||
|
|
||||||
|
Server runs on `http://localhost:3000` by default.
|
||||||
|
|||||||
Reference in New Issue
Block a user