wulkanowy-web/README.md

50 lines
791 B
Markdown
Raw Permalink Normal View History

2021-09-06 12:09:05 +02:00
# Wulkanowy Web
🌋 Unofficial VULCAN UONET+ browser client for students and their parents
![GitHub Workflow Status](https://github.com/wulkanowy/wulkanowy-web/workflows/Python%20application/badge.svg)
## Join our Discord server!
[![Discord](https://discordapp.com/api/guilds/390889354199040011/widget.png?style=banner2)](https://discord.com/invite/vccAQBr)
# Development
## 1. Install dependencies
```sh
Completely new backend and reworked frontend by Marioneq (#93) * Rewrited Frontend by Marioneq * Rewrited Backend by Marioneq * Delete old backend and update workflows * Deleting files on Marioneq command * Deleting files on Marioneq command * Deleting files on Marioneq command * Corrections with Marioneq command * Rename Appbar.vue to AppBar.vue * Try to fix backend workflow * Try to fix backend workflow 2 * Try to fix backend workflow 3 * Try to fix python workflow part 4 * Update python version * Update requirements.txt * Fix frontend * Simple backend test * Hotfix for backend workflow * Update dependencies * Revert "Update dependencies" This reverts commit 6b610ff6e398052bf2a98e47c0984c83e46db8a4. * Add few test * Update test.py * Update backend * Add /notes test. * Add /grades test * Update backend * Add more tests * Update the tests to make them easier to configure * Update code format * Color workflow test * Update requirements * Updated backend test * Test workflow reaction * Temporary add workflow reaction * Try update test logic * Delete postgres image * Update docker file * Print response code in backend test * Add color to workflow * Test workflow colors * Add colorama to requirements.txt * Test color * Fix all colors * Colors * FINALLY FIX THE COLORS * Add extended support for if * Hotflix for backend test * Delete many if from backend test * Updating backend test * Update backend test * Changes requested by Pengwius * Changes requested by MRmlik12 * Changes requested by MRmlik12 part 2 * Fix rules * Change api.ts requested by MRmlik12 * Update Account Manager * Fix Panel * Changes requested by MRmlik12 part 3 * Fix - Changes requested by MRmlik12 part 3 * Update login.py * Fix login.py * Fix login.py part 2 * Fix SelectStudent.vue * Update package-lock.json * Update main.py * Update variables name * Fix changes requested by MarcinK50 * Add invalid url error Co-authored-by: Marioneq 4958 <mq4958@gmail.com> Co-authored-by: Marioneq Marioneqowski <marioneq4958@gmail.com>
2022-05-22 21:00:45 +02:00
cd backend
2021-09-06 12:09:05 +02:00
pip install -r requirements.txt
```
And in frontend:
```sh
cd frontend
npm install
2021-09-06 12:09:05 +02:00
```
Completely new backend and reworked frontend by Marioneq (#93) * Rewrited Frontend by Marioneq * Rewrited Backend by Marioneq * Delete old backend and update workflows * Deleting files on Marioneq command * Deleting files on Marioneq command * Deleting files on Marioneq command * Corrections with Marioneq command * Rename Appbar.vue to AppBar.vue * Try to fix backend workflow * Try to fix backend workflow 2 * Try to fix backend workflow 3 * Try to fix python workflow part 4 * Update python version * Update requirements.txt * Fix frontend * Simple backend test * Hotfix for backend workflow * Update dependencies * Revert "Update dependencies" This reverts commit 6b610ff6e398052bf2a98e47c0984c83e46db8a4. * Add few test * Update test.py * Update backend * Add /notes test. * Add /grades test * Update backend * Add more tests * Update the tests to make them easier to configure * Update code format * Color workflow test * Update requirements * Updated backend test * Test workflow reaction * Temporary add workflow reaction * Try update test logic * Delete postgres image * Update docker file * Print response code in backend test * Add color to workflow * Test workflow colors * Add colorama to requirements.txt * Test color * Fix all colors * Colors * FINALLY FIX THE COLORS * Add extended support for if * Hotflix for backend test * Delete many if from backend test * Updating backend test * Update backend test * Changes requested by Pengwius * Changes requested by MRmlik12 * Changes requested by MRmlik12 part 2 * Fix rules * Change api.ts requested by MRmlik12 * Update Account Manager * Fix Panel * Changes requested by MRmlik12 part 3 * Fix - Changes requested by MRmlik12 part 3 * Update login.py * Fix login.py * Fix login.py part 2 * Fix SelectStudent.vue * Update package-lock.json * Update main.py * Update variables name * Fix changes requested by MarcinK50 * Add invalid url error Co-authored-by: Marioneq 4958 <mq4958@gmail.com> Co-authored-by: Marioneq Marioneqowski <marioneq4958@gmail.com>
2022-05-22 21:00:45 +02:00
## 2. Start the server
2021-09-06 12:09:05 +02:00
```sh
Completely new backend and reworked frontend by Marioneq (#93) * Rewrited Frontend by Marioneq * Rewrited Backend by Marioneq * Delete old backend and update workflows * Deleting files on Marioneq command * Deleting files on Marioneq command * Deleting files on Marioneq command * Corrections with Marioneq command * Rename Appbar.vue to AppBar.vue * Try to fix backend workflow * Try to fix backend workflow 2 * Try to fix backend workflow 3 * Try to fix python workflow part 4 * Update python version * Update requirements.txt * Fix frontend * Simple backend test * Hotfix for backend workflow * Update dependencies * Revert "Update dependencies" This reverts commit 6b610ff6e398052bf2a98e47c0984c83e46db8a4. * Add few test * Update test.py * Update backend * Add /notes test. * Add /grades test * Update backend * Add more tests * Update the tests to make them easier to configure * Update code format * Color workflow test * Update requirements * Updated backend test * Test workflow reaction * Temporary add workflow reaction * Try update test logic * Delete postgres image * Update docker file * Print response code in backend test * Add color to workflow * Test workflow colors * Add colorama to requirements.txt * Test color * Fix all colors * Colors * FINALLY FIX THE COLORS * Add extended support for if * Hotflix for backend test * Delete many if from backend test * Updating backend test * Update backend test * Changes requested by Pengwius * Changes requested by MRmlik12 * Changes requested by MRmlik12 part 2 * Fix rules * Change api.ts requested by MRmlik12 * Update Account Manager * Fix Panel * Changes requested by MRmlik12 part 3 * Fix - Changes requested by MRmlik12 part 3 * Update login.py * Fix login.py * Fix login.py part 2 * Fix SelectStudent.vue * Update package-lock.json * Update main.py * Update variables name * Fix changes requested by MarcinK50 * Add invalid url error Co-authored-by: Marioneq 4958 <mq4958@gmail.com> Co-authored-by: Marioneq Marioneqowski <marioneq4958@gmail.com>
2022-05-22 21:00:45 +02:00
cd backend
py -m main
2021-09-06 12:09:05 +02:00
```
And in frontend:
```sh
2021-09-06 12:09:05 +02:00
cd frontend
Completely new backend and reworked frontend by Marioneq (#93) * Rewrited Frontend by Marioneq * Rewrited Backend by Marioneq * Delete old backend and update workflows * Deleting files on Marioneq command * Deleting files on Marioneq command * Deleting files on Marioneq command * Corrections with Marioneq command * Rename Appbar.vue to AppBar.vue * Try to fix backend workflow * Try to fix backend workflow 2 * Try to fix backend workflow 3 * Try to fix python workflow part 4 * Update python version * Update requirements.txt * Fix frontend * Simple backend test * Hotfix for backend workflow * Update dependencies * Revert "Update dependencies" This reverts commit 6b610ff6e398052bf2a98e47c0984c83e46db8a4. * Add few test * Update test.py * Update backend * Add /notes test. * Add /grades test * Update backend * Add more tests * Update the tests to make them easier to configure * Update code format * Color workflow test * Update requirements * Updated backend test * Test workflow reaction * Temporary add workflow reaction * Try update test logic * Delete postgres image * Update docker file * Print response code in backend test * Add color to workflow * Test workflow colors * Add colorama to requirements.txt * Test color * Fix all colors * Colors * FINALLY FIX THE COLORS * Add extended support for if * Hotflix for backend test * Delete many if from backend test * Updating backend test * Update backend test * Changes requested by Pengwius * Changes requested by MRmlik12 * Changes requested by MRmlik12 part 2 * Fix rules * Change api.ts requested by MRmlik12 * Update Account Manager * Fix Panel * Changes requested by MRmlik12 part 3 * Fix - Changes requested by MRmlik12 part 3 * Update login.py * Fix login.py * Fix login.py part 2 * Fix SelectStudent.vue * Update package-lock.json * Update main.py * Update variables name * Fix changes requested by MarcinK50 * Add invalid url error Co-authored-by: Marioneq 4958 <mq4958@gmail.com> Co-authored-by: Marioneq Marioneqowski <marioneq4958@gmail.com>
2022-05-22 21:00:45 +02:00
npm run serve
2021-09-06 12:09:05 +02:00
```
# Docker
With docker compose
```sh
docker-compose up -d
```
Without docker compose
```sh
docker build -t wulkanowy/web .
docker run -d -p 8000:8000 wulkanowy/web
```