Lliçons

Lliçons is a simple and elegant learning management system (LMS) designed to help educators create, manage, and deliver online courses. It provides a user-friendly interface for both instructors and students, making it easy to navigate through course materials, assignments, and assessments.

Lliçons is available at https://lliçons.jutge.org.

Contributions are welcome!

Installation

To install Lliçons, follow these steps:

1. Install Bun.

   See https://bun.com/

2. Fork the https://github.com/jordi-petit/llicons-noves repository on GitHub.

3. Clone your forked repository:

   git clone [email protected]:<your-username>/llicons-noves.git

Development

There are different courses available: index, python, cpp, terminal and electronica-digital. Each of them is a VitePress project. There is also a template directory that contains a template to help creating a new course.

To start the development server on one of the courses (say python), go to its main directory:

cd python

To create a new course, copy the template course to a new directory with the name of the course you want to create:

cp -r template my-new-course
cd my-new-course

Install the dependencies with this command:

bun install

To run the development server, execute:

bun run dev

Open your browser and navigate to http://localhost:5173/, where PORT is the port number assigned to the VitePress server (this is displayed). In this window, you can view the course content with live updates.

The actual contents for the courses are in the src directory of each course. Each page corresponds to a Markdown file. You can edit and add files directly, and the changes will be reflected in real-time in your browser. You can use src/public to store static assets that you want to include in your course pages. See existing courses for examples of how to structure your content.

There is also a hidden .vitepress directory in each course, which contains the configuration files for VitePress. You can customize the appearance and behavior of the courses by modifying these files. In particular, the .vitepress/index.js file allows you to set the table of contents for the course. The .vitepress/theme/Autors.vue file is used to display the authors of the course at the bottom of each page.

Deployment

In order to build the courses for production, execute

bun run build

This will generate the static files in the dist directory. Check that no errors are reported during the build process.

You cannot deploy the courses directly to the server. Instead, commit your changes to the main branch of your forked repository and then create a pull request to the original repository. The maintainers will review your changes and deploy them to the live site.

Credits

Lliçons is developed and maintained by Jordi Petit within the Jutge.org team of the Computer Science department at the Universitat Politècnica de Catalunya. The course pages are authored by various contributors, including students and educators, see their credits at the bottom of each page.

© Universitat Politècnica de Catalunya. All rights reserved.