2021-04-20 23:01:27 +02:00
|
|
|
# Wulkanowy Web
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
🌋 Unofficial VULCAN UONET+ browser client for students and their parents
|
2021-01-26 18:35:17 +01:00
|
|
|
|
2021-04-20 23:26:58 +02:00
|
|
|
![GitHub Workflow Status](https://github.com/wulkanowy/wulkanowy-web/workflows/Python%20application/badge.svg)
|
2021-04-14 19:58:29 +02:00
|
|
|
|
2021-04-20 22:54:21 +02:00
|
|
|
## Join our Discord server!
|
|
|
|
|
2021-04-20 23:33:02 +02:00
|
|
|
[![Discord](https://discordapp.com/api/guilds/390889354199040011/widget.png?style=banner2)](https://discord.gg/5qsEujZMdp)
|
2021-04-14 19:58:29 +02:00
|
|
|
|
2021-01-26 18:35:17 +01:00
|
|
|
# Development
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
## 1. Install dependencies
|
|
|
|
|
|
|
|
```sh
|
2021-01-26 18:35:17 +01:00
|
|
|
pip install -r requirements.txt
|
2021-04-20 23:12:24 +02:00
|
|
|
npm i
|
2021-01-26 18:35:17 +01:00
|
|
|
```
|
2021-04-20 22:54:21 +02:00
|
|
|
|
2021-01-28 20:48:04 +01:00
|
|
|
## 2. Make migrations
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
```sh
|
2021-01-26 18:35:17 +01:00
|
|
|
python manage.py makemigrations
|
|
|
|
python manage.py migrate
|
|
|
|
```
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
## 3. Start the server
|
|
|
|
|
|
|
|
```sh
|
2021-01-26 18:35:17 +01:00
|
|
|
python manage.py runserver
|
2021-04-20 23:12:24 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
```sh
|
|
|
|
cd frontend
|
2021-02-05 13:18:25 +01:00
|
|
|
npm run dev
|
2021-01-26 18:55:57 +01:00
|
|
|
```
|
2021-04-07 10:04:54 +02:00
|
|
|
|
|
|
|
# Docker
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
With docker compose
|
|
|
|
|
|
|
|
```sh
|
2021-04-07 10:04:54 +02:00
|
|
|
docker-compose up -d
|
|
|
|
```
|
2021-04-20 22:54:21 +02:00
|
|
|
|
|
|
|
Without docker compose
|
|
|
|
|
|
|
|
```sh
|
2021-04-07 10:04:54 +02:00
|
|
|
docker build -t wulkanowy/web .
|
2021-04-14 19:58:29 +02:00
|
|
|
docker run -d -p 8000:8000 wulkanowy/web
|
2021-04-20 22:54:21 +02:00
|
|
|
```
|