{"id":27944763,"url":"https://github.com/benportner/seminar-ts-server","last_synced_at":"2025-05-07T12:54:26.039Z","repository":{"id":287639410,"uuid":"965353545","full_name":"BenPortner/seminar-ts-server","owner":"BenPortner","description":"A platform to support interactive features like chats, white boards... in reveal.js presentations.","archived":false,"fork":false,"pushed_at":"2025-04-13T01:16:29.000Z","size":1306,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T02:22:20.118Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BenPortner.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-13T01:07:33.000Z","updated_at":"2025-04-13T01:16:32.000Z","dependencies_parsed_at":"2025-04-13T02:32:51.822Z","dependency_job_id":null,"html_url":"https://github.com/BenPortner/seminar-ts-server","commit_stats":null,"previous_names":["benportner/seminar-ts-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenPortner%2Fseminar-ts-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenPortner%2Fseminar-ts-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenPortner%2Fseminar-ts-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenPortner%2Fseminar-ts-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BenPortner","download_url":"https://codeload.github.com/BenPortner/seminar-ts-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252882817,"owners_count":21819153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T12:54:25.030Z","updated_at":"2025-05-07T12:54:26.028Z","avatar_url":"https://github.com/BenPortner.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Seminar TS Server\r\n\r\nThis project is a TypeScript-based rewrite of the original [Reveal.js seminar server](https://github.com/rajgoel/seminar). The rewrite leverages TypeScript to improve code maintainability, scalability, and developer experience. It is meant to be a drop-in replacement, meaning all your favorite [Reveal.js plugins](https://github.com/rajgoel/reveal.js-plugins/tree/master/seminar) will still work out of the box.\r\n\r\n** NEW ** The server now has a built-in web UI for admins, courtesy of [Socket.IO Admin UI](https://github.com/socketio/socket.io-admin-ui/). From here, you can see information about all connected sockets and rooms. To reach it, start the server and visit `http://your-host:your-port/admin` (e.g. http://localhost:4433/admin).\r\n\r\n---\r\n\r\n## Installation\r\n\r\n1. **Clone the Repository**:\r\n   ```bash\r\n   git clone https://github.com/your-username/seminar-ts-server.git\r\n   cd seminar-ts-server\r\n   ```\r\n\r\n2. **Install Dependencies**:\r\n   Ensure you have Node.js (\u003e= 22.0.0) installed. Then run:\r\n   ```bash\r\n   npm install\r\n   ```\r\n\r\n3. **Set Up Environment Variables**:\r\n   Create `.env.dev` and `.env.prod` files in the env directory for development and production configurations. Example:\r\n   ```plaintext\r\n   NODE_ENV=development\r\n   PORT=4433\r\n   SOCKETIO_ADMINUI_AUTH=false\r\n   ```\r\n\r\n4. **Run the Server**:\r\n   - For development:\r\n     ```bash\r\n     npm run dev\r\n     ```\r\n   - For production:\r\n     ```bash\r\n     export NODE_ENV=production\r\n     npm run start\r\n     ```\r\n\r\n---\r\n\r\n## Clients\r\n\r\nClients can be obtained from the [Reveal.js seminar plugins repository](https://github.com/rajgoel/reveal.js-plugins/tree/master/seminar). If you have a server running on `localhost`, you can check out the live demo [here](https://rajgoel.github.io/reveal.js-demos/?topic=seminar).\r\n\r\n---\r\n\r\n## Why TypeScript?\r\n\r\nTypeScript offers several advantages over vanilla JavaScript:\r\n\r\n1. **Static Typing**: Helps catch errors at compile time, reducing runtime bugs.\r\n2. **Improved Tooling**: Provides better IntelliSense, autocompletion, and refactoring support in IDEs.\r\n3. **Scalability**: Improved tooling means it is easier to extend the codebase and implement new features.\r\n4. **Maintainability**: Strong typing and interfaces improve code readability and maintainability.\r\n5. **Modern JavaScript Features**: TypeScript supports the latest JavaScript features and compiles to CommonJS. \r\n\r\n---\r\n\r\n## Project Structure\r\n\r\nThe project is organized as follows:\r\n\r\n- **src**: Main source code directory.\r\n  - **`models/`**: Class definitions for `User`, `Room`, and `Message`.\r\n  - **`db/`**: In-memory store for `User`, `Room` and `Message` objects.\r\n  - **`types/`**: Type definitions for events, payloads, and data structures.\r\n  - **`handlers/`**: Event handlers for incoming Socket.IO events.\r\n  - **`utils/`**: Utility functions for common tasks.\r\n  - **`server.ts`**: Main server implementation using Socket.IO.\r\n  - **`main.ts`**: Entry point for the application.\r\n- **public**: Static files served by the server.\r\n- **env**: Environment-specific configuration files.\r\n\r\n---\r\n\r\n## Contributing\r\n\r\n1. Fork the repository.\r\n2. Create a new branch for your feature or bugfix.\r\n3. Submit a pull request with a clear description of your changes.\r\n\r\n---\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See the LICENSE file for details.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenportner%2Fseminar-ts-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenportner%2Fseminar-ts-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenportner%2Fseminar-ts-server/lists"}