Small README changes

This commit is contained in:
JelNiSław 2021-04-20 22:54:21 +02:00
parent 61c4a06bd2
commit 7ba8728a8c
No known key found for this signature in database
GPG key ID: 0328C082AD5595E1

View file

@ -1,40 +1,47 @@
# Wulkanowy-web
🌋 Unofficial browser VULCAN UONET+ client for both students and their parents
# 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)
## Come to our discord server!
## Join our Discord server!
[![Discord](https://i.imgur.com/3ljTQWy.png)](https://discord.gg/5qsEujZMdp)
# Development
## 1. Install dependencies.
```shell
## 1. Install dependencies
```sh
pip install -r requirements.txt
```
And in frontend:
```shell
npm install
```
## 2. Make migrations
```shell
```sh
python manage.py makemigrations
python manage.py migrate
```
## 3. Start the server!
```shell
## 3. Start the server
```sh
python manage.py runserver
```
And in frontend:
```shell
npm run dev
```
# Docker
## With docker compose
```shell
With docker compose
```sh
docker-compose up -d
```
## Without docker compose
```shell
Without docker compose
```sh
docker build -t wulkanowy/web .
docker run -d -p 8000:8000 wulkanowy/web
```