Skip to content
/ ifv Public
forked from banocean/ifv
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ root = true
[*]
indent_style = space
indent_size = 4
end_of_line = crlf
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false
trim_trailing_whitespace = true
insert_final_newline = true
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
release
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2024 BanOcean
Copyright (c) 2024-2025 BanOcean
Copyright (c) 2024-2026 IFV & Hephaestus Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
86 changes: 50 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,105 @@
# Improvements for VULCAN
# Hephaestus

Browser extension with improvements for eduVULCAN and Dziennik VULCAN.
Browser extension with improvements for █████████ and ████████ ██████.

## Installation

<a href="https://ifv.banocean.com/downloads/firefox"><img src="./assets/add to firefox.svg"></a><img width=10px><a href="https://ifv.banocean.com/downloads/chrome"><img src="./assets/add to chrome.svg"></a>

[Installation guide [PL]](https://ifv.banocean.com)<br>
[Adding extension to browsers for development](#development-workflow)
[Adding the extension to browsers for development](#development-workflow)

## Features

<details>
<summary>Mobile navigation</summary>

| Before: | After: |
| --------------------------------------------------------------- | -------------------------------------------------------------- |
| <img src="./screenshots/mobileNavBefore.png" width="300px" /> | <img src="./screenshots/mobileNavAfter.png" width="300px" /> |
| Before: | After: |
| -------------------------------------------------------------------- | ------------------------------------------------------------------- |
| <img src="./public/screenshots/mobileNavBefore.png" width="300px" /> | <img src="./public/screenshots/mobileNavAfter.png" width="300px" /> |

</details>
<details>
<summary>PWA support</summary>
<img src="./screenshots/pwa.png" width="300px" />
<img src="./public/screenshots/pwa.png" width="300px" />
</details>

<details>
<summary>Attendance statistics in separate tab</summary>
<summary>Attendance statistics in a separate tab</summary>

| Before: | After: |
| --------------------------------------------------------------------- | -------------------------------------------------------------------- |
| <img src="./public/screenshots/attendanceBefore.png" width="300px" /> | <img src="./public/screenshots/attendanceAfter.png" width="300px" /> |

| Before: | After: |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| <img src="./screenshots/attendanceBefore.png" width="300px" /> | <img src="./screenshots/attendanceAfter.png" width="300px" /> |
</details>
<details>
<summary>Hiding weekends in monthy calendars</summary>

| Before: | After: |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| <img src="./screenshots/hideWeekendsBefore.png" width="300px" /> | <img src="./screenshots/hideWeekendsAfter.png" width="300px" /> |
<summary>Hide weekends in monthly calendars</summary>

| Before: | After: |
| ----------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| <img src="./public/screenshots/hideWeekendsBefore.png" width="300px" /> | <img src="./public/screenshots/hideWeekendsAfter.png" width="300px" /> |

</details>
<details>
<summary>Displaying full name</summary>
<summary>Display full name</summary>

| Before: | After: |
| ---------------------------------------------------------------- | --------------------------------------------------------------- |
| <img src="./public/screenshots/fnameBefore.png" width="300px" /> | <img src="./public/screenshots/fnameAfter.png" width="300px" /> |

| Before: | After: |
| --------------------------------------------------------------- | -------------------------------------------------------------- |
| <img src="./screenshots/fnameBefore.png" width="300px" /> | <img src="./screenshots/fnameAfter.png" width="300px" /> |
</details>
<details>
<summary>Clean student dashboard</summary>
<summary>A cleaner student dashboard</summary>

Before:

<img src="./screenshots/whiteboardBefore.png" width="800px" />
<img src="./public/screenshots/whiteboardBefore.png" width="800px" />

After:

<img src="./screenshots/whiteboardAfter.png" width="800px" />
<img src="./public/screenshots/whiteboardAfter.png" width="800px" />
</details>

<details>
<summary>Clean eduVULCAN home</summary>
<summary>A cleaner █████████ home</summary>

| Before: | After: |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| <img src="./screenshots/evHomeBefore.png" width="300px" /> | <img src="./screenshots/evHomeAfter.png" width="300px" /> |
| Before: | After: |
| ----------------------------------------------------------------- | ---------------------------------------------------------------- |
| <img src="./public/screenshots/evHomeBefore.png" width="300px" /> | <img src="./public/screenshots/evHomeAfter.png" width="300px" /> |

</details>

<details>
<summary>Other minor improvements</summary>
<summary>Other minor enhancements</summary>

- Hiding WCAG controls
- Aligning detailed grades button
- Redirecting to board
- Auto redirecting to eduVULCAN login page
</details>
- Auto-redirecting to █████████ login page
</details>

## Development Workflow

### Build the extension

1. Make sure you have [Bun](https://bun.sh/) installed.
2. Install required dependencies using `bun install`, then use `bun simple-git-hooks` to set up pre-commit hook, which formats your code using prettier and lints it with eslint.
3. Use `bun dev` to start development server or `bun build` to build a package.

### Firefox
To load addon from files in Firefox, you need to go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`. After that you need to select manifest.json file in file picker.<br>
<img src="./screenshots/firefoxDebug.png">

To load add-on from files in Firefox, you need to go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`. After that you need to select the `manifest.json` file from `dist/` folder in the file picker.<br>
<img src="./public/screenshots/firefoxDebug.png">

### Chrome
To load extension from files in Chrome, you need to go to `chrome://extensions/` and click `Load unpacked` (with developer mode enabled)<br>
<img src="./screenshots/chromeDebug.png">

To load extension from files in Chrome, you need to go to `chrome://extensions/` and click `Load unpacked` (with Developer mode enabled)<br>
<img src="./public/screenshots/chromeDebug.png">

## License

This project is licensed under the [MIT License](./LICENSE).

## Contributions

Contributions to this project are welcome. Feel free to [open issues](https://github.com/banocean/ifv/issues) and [submit pull requests](https://github.com/banocean/ifv/pulls).
Contributions to this project are welcome. Feel free to [open issues](https://github.com/yoper12/ifv/issues) and [submit pull requests](https://github.com/yoper12/ifv/pulls).
116 changes: 0 additions & 116 deletions apply.js

This file was deleted.

Binary file removed assets/logo/logo-128-blue.png
Binary file not shown.
Binary file removed assets/logo/logo-128-red.png
Binary file not shown.
Binary file removed assets/logo/logo-192-blue.png
Binary file not shown.
Binary file removed assets/logo/logo-192-red.png
Binary file not shown.
Binary file removed assets/logo/logo-512-blue.png
Binary file not shown.
Binary file removed assets/logo/logo-512-red.png
Binary file not shown.
Loading