README

Assignments-Viewer for Moodle

Report a Bug · Request a Feature · Ask a Question

A simple web application that lists the currently due assignments of a Moodle™ user.

It accesses the Moodle instance via the Moodle Mobile Web Service API, which is also used by the official Moodle mobile app.

To be able to use it with a Moodle instance, the Moodle Mobile Web Services must explicitly be enabled by the instance.

=> If the Moodle mobile app can be used, then this application can also be used.

🤔 Why?

The student life, what a wonderful time, isn't it?

If only there weren't assignments to be done.

What started out as a procrastination side-task (we all know them, right? 🤫), became a nice application for listing currently due assignments (we all love them, don't we? 💚).

📖 Table of Contents

Click to expand

📖 Table of Contents
⛓ Features
🚀 Getting Started
🍿 Deployment
🔨 Development
Changelog
Help & Questions
Contributing
👤 Author
📎 Links
💛 Support
⚖️ Disclaimer
📃 License

⛓ Features

List all current due assignments for the given Moodle user.
Different colors indicate the approaching due date:
- Pink: 1 day, Red: 2 days, Yellow: 3 days.

🚀 Getting Started

Requirements

Git
php >= 8.3
Composer

Installation

Download or Clone the Project

composer create-project stevenfoncken/assignments-viewer-for-moodle-php

git clone --depth 1 https://github.com/stevenfoncken/assignments-viewer-for-moodle-php.git

Now cd into the project directory.

Install Dependencies via Composer

Skip when create-project was used.

composer install

Note: Composer scripts are required due to the deploy-dir structure.

Install Frontend

yarn install

yarn build

Config

.env

cp deploy/config/.env.dist deploy/config/.env

Key	Description
MOODLE_BASE_URL	URL of the Moodle instance.
MOODLE_USERNAME	Your Moodle username.
MOODLE_PASSWORD	Your Moodle password.
SETTING_HIDE_SUBMITTED_ASSIGNMENTS	Hide submitted assignments in overview.
SETTING_PAST_ASSIGNMENTS_DAYS_COUNT	Number of days to display past assignments.
SETTING_ASSIGNMENTS_CACHE_EXPIRES_AFTER_SEC	Cache expiration date of the stored assignments data.
APP_TIMEZONE	List of Supported Timezones

🍿 Deployment

Deployment Root: (contents of) deploy/ (e.g. /var/www/example_site/)

Document Root: docroot/ (e.g. /var/www/example_site/docroot/)

🔨 Development

Tech Stack

The Backend is written in PHP.

The Frontend is based on plain HTML & SCSS. Package manager: yarn. Bundler: webpack.

Working on FRONTEND

Build config: build/frontend/

Source files: assets-src/

Compiled files: deploy/docroot/dist/

Working on BACKEND

Source files: deploy/src/

Changelog

Please see CHANGELOG.md for more information on what has changed recently.

Help & Questions

Start a new discussion in the Discussions Tab.

Contributing

... is welcome.

Just fork the repository and create a pull request.

For major changes, please first start a discussion in the Discussions Tab to discuss what you would like to change.

IMPORTANT: By submitting a patch, you agree to allow the project owner(s) to license your work under the terms of the MIT License.

Thank you!

👤 Author

assignments-viewer-for-moodle-php is primarily written and maintained by:

🦜 Steven Foncken

Website: stevenfoncken.de

GitHub: @stevenfoncken

LinkedIn: Steven Foncken (@stevenfoncken)

📎 Links

💛 Support

If this project was helpful for you or your organization, please consider supporting my work directly:

⭐️ Star this project on GitHub
🐙 Follow me on GitHub

Everything helps, thanks! 🙏

⚖️ Disclaimer

"Moodle" is a registered trademark of "Moodle Pty Ltd" and/or its (worldwide) subsidiaries.

This project or its author is in no way officially connected to, affiliated with, associated with, authorized by, built by, endorsed by, licensed by, maintained by, promoted by, or sponsored by "Moodle Pty Ltd" or any of its affiliates, licensors, (worldwide) subsidiaries, or other entities under its control.

All trademarks are the property of their respective owners.

This is an independent project that utilizes "Moodle"s Mobile Web Service API to fetch assignments data of the given user.

Before taking legal action, please contact this address: <dev[at]stevenfoncken[dot]de>

Use at your own risk.

📃 License

assignments-viewer-for-moodle-php is licensed under the MIT License.

See LICENSE for details.

^ back to top ^

stevenfoncken / assignments-viewer-for-moodle-php

Maintainers

Details