docs(README.md): add README
This commit is contained in:
89
README.md
Normal file
89
README.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Studio77 (kursy)
|
||||
|
||||
## Instalacja
|
||||
|
||||
### Wymagania
|
||||
|
||||
- `uv` >= 0.11.0
|
||||
- `python` >= 3.14 (instalowany automatycznie przez `uv`)
|
||||
- `node` >= 24.14.1 (LTS)
|
||||
- `npm` >= 9.2.0 (LTS)
|
||||
|
||||
### Instalacja wymaganych narzędzi
|
||||
|
||||
1. `uv` - można zainstalować za pomocą skryptu instalacyjnego dostępnego na [stronie projektu](https://docs.astral.sh/uv/getting-started/installation):
|
||||
|
||||
```bash
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
2. `node` i `npm` - można zainstalować za pomocą [Node Version Manager (nvm)](https://nodejs.org/en/download):
|
||||
|
||||
```bash
|
||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.4/install.sh | bash
|
||||
|
||||
\. "$HOME/.nvm/nvm.sh"
|
||||
|
||||
nvm install 24
|
||||
```
|
||||
|
||||
### Instalacja projektu
|
||||
|
||||
1. Sklonuj repozytorium:
|
||||
|
||||
```bash
|
||||
git clone http://192.168.190:3000/StudioCodeLab/kursy.git
|
||||
cd kursy
|
||||
```
|
||||
|
||||
2. Zainstaluj zależności:
|
||||
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
3. Zainstaluj zależności tailwind:
|
||||
|
||||
```bash
|
||||
cd theme/static_src
|
||||
npm install
|
||||
cd ../..
|
||||
```
|
||||
|
||||
## Pierwsze uruchomienie
|
||||
|
||||
1. Wykonaj migracje bazy danych:
|
||||
|
||||
```bash
|
||||
uv run python manage.py migrate
|
||||
```
|
||||
|
||||
2. Utwórz superużytkownika (admina):
|
||||
|
||||
```bash
|
||||
uv run python manage.py createsuperuser
|
||||
```
|
||||
|
||||
## Użycie
|
||||
|
||||
### Uruchom serwery
|
||||
|
||||
- Django:
|
||||
|
||||
```bash
|
||||
uv run python manage.py runserver
|
||||
```
|
||||
|
||||
- Tailwind:
|
||||
|
||||
```bash
|
||||
cd theme/static_src
|
||||
npm run dev
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Oba serwery muszą być uruchomione równolegle, aby aplikacja działała poprawnie.
|
||||
|
||||
## Autorzy
|
||||
|
||||
- [Artur Borecki](https://github.com/pufereq)
|
||||
Reference in New Issue
Block a user