Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bartek20/ZSM-TimeTable
https://github.com/Bartek20/ZSM-TimeTable
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Bartek20/ZSM-TimeTable
- Owner: Bartek20
- Created: 2023-03-06T16:09:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T22:42:06.000Z (7 months ago)
- Last Synced: 2024-04-13T11:00:42.309Z (7 months ago)
- Language: JavaScript
- Homepage: https://zsm-timetable.pages.dev
- Size: 1.86 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Projekt ZSM TimeTable
Aplikacja została przygotowana w ramach projektu dodatkowego.
Miała na celu dodanie nowego planu lekcji do strony Zespołu Szkół Mechanicznych w Rzeszowie.
## Zastosowanie w innej szkole
Wykorzystanie aplikacji w innej szkole jest możliwe, jednak może to wymagać ręcznych zmian w kodzie aplikacji.
Zabronione jest jednak usuwanie, jak i modyfikowanie informacji o autorze kodu (dopuszczalne jest dodanie informacji o osobie odpowiedzialnej za dostosowanie kodu dla szkoły).
## Kompilacja aplikacji
### 1) Przed rozpoczęciem kompilacji należy dostosować aplikację poprzez:
\* Opcjonalnie - Wymagane założenie konta i znajomość obsługi panelu
- Zmienienie loga szkoły (plik /public/images/logo.png)
- \* Wprowadzenie zmiennej środowiskowej ***CF_BEACON_TOKEN*** (Do śledzenia statystyk poprzez Cloudflare Insights)
- \* Wprowadzenie zmiennej środowiskowej ***SENTRY_DSN_URL*** (Do automatycznego zgłaszania błędów poprzez Sentry)
### 2) Po dostosowaniu aplikacji do potrzeb szkoły należy skompilować program:
#### 2a) Dla domyślnej ścieżki (https://example.com)
```bash
npm run build
```
#### 2b) Dla własnej ścieżki (https://example.com/plan_lekcji)
```bash
npm run build -- --base "/ściezka/"
```
### 3) Następnie należy skopiować pliki z folderu _dist_ na serwer szkolny, do ścieżki, która została wcześniej zadeklarowana.
### 4) Po skopiowaniu plików należy:
- **[OBOWIĄZKOWO]** *Dotyczy serwera Apache (w innej sytuacji należy ręcznie dostosować serwer)*
Wybrać prawidłowy dla domeny plik **_.htaccess_** (www lub non-www) i zmienić jego nazwę na _.htaccess_ (drugi plik należy usunąć)
- **[OBOWIĄZKOWO]**
Dostosować dane szkoły zgodnie z plikiem **_schoolData.template.js_** (zmienić nazwę na _schoolData.js_ i dostosować zawartość)
- **[OPCJONALNIE]**
Dostosować dane planu lekcji zgodnie z plikiem **_timetableData.template.js_** (zmienić nazwę na _timetableData.js_ i dostosować zawartość)
- **[OPCJONALNIE]**
W pliku index.html edytuj podaną linię:
***"\"***
dodając adres planu lekcji firmy Vulkan i usuwając komentarz
### 5) Dostosowanie planu Vulcan (*Dotyczy serwera Apache - w innej sytuacji należy ręcznie dostosować serwer*):
- Do pliku *.htaccess* w głównej ścieżce domeny, w której znajdują się **pliki planu lekcji firmy Vulcan** dodać podany kod:
```.htaccess
# BEGIN Konfiguracja do obsługi planu lekcji
# Blokowanie indexowania
Header set X-Robots-Tag "noindex, nofollow, noarchive"
# Dostęp CORS do planów
Header set Access-Control-Allow-Origin "*"
Header set Access-Control-Allow-Headers "*"
# Wyłączenie pamięci Cache przeglądarek
Header set Cache-Control "max-age=0, no-cache, no-store, must-revalidate"
Header set Pragma "no-cache"
Header set Expires "0"
Header unset ETag
Header unset Last-Modified
# END Konfiguracja do obsługi planu lekcji
```
\* Należy dostosować ścieżkę do planu zastępując "/plan" ścieżką do planu (musi zaczynać się od "/") np.:
- "https://example.com/plan" -> "/plan"
- "https://example.com/dokumenty/plan_lekcji" -> "/dokumenty/plan_lekcji"
## Zastosowane technologie
### W wydaniu produkcyjnym:
- Vue.js 3 (Vue Router, @VueUse, Floating Vue)
- Axios.js - Pobieranie planów lekcji
- Chroma.js - Generowanie kolorów lekcji
- @nozbe/microfuzz - Wyszukiwarka
- vue-toastification - Powiadomienia w formie toastów
#### Do monitorowania błędów i wydajności
- Cloudflare Insights
- Sentry Vue App Monitoring
### Środowisko deweloperskie:
- Node.js 20
- Vite
- Unplugin Auto Imports
- Unplugin Vue Components
- Vite PWA Plugin