Skip to content
This repository has been archived by the owner on Jan 18, 2025. It is now read-only.

Commit

Permalink
docs: note for just usage
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinNitroG committed Jan 9, 2025
1 parent 954bc19 commit 526e49b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
26 changes: 15 additions & 11 deletions docs/dev/setup.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
```sh
uv sync # no need uv venv
# Setup

.venv/Scripts/activate # or "source .venv/bin/active" on Linux
## Run check-phat-nguoi

```sh
just
```

# uv can detect env with "uv run", not need active venv
pre-commit install
## Export schemas

check-phat-nguoi
generate-schemas
generate-config-schema
```sh
just s
```

???+note
if no activating venv, you must prepend `uv run` before commands
## Build web

```sh
just w
```

# Test on production with python 3.10

Expand All @@ -25,4 +29,4 @@ check-phat-nguoi
```

???+note
Can export var env `VIRTUAL_ENV=.venv-3.10`
Can export var env `VIRTUAL_ENV=.venv-3.10`
8 changes: 4 additions & 4 deletions docs/usage/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ python -m venv .venv
=== "Windows"

```powershell
.venv/Scripts/activate
.venv\Scripts\activate
```

=== "Linux / MacOS"
=== "Unix / MacOS"

```sh
source .venv/bin/active
source .venv/bin/activate
```

#### Cài đặt dependencies

```sh
pip install -e -r requirements.txt
pip install -e . -r requirements.txt
```

???+note
Expand Down

0 comments on commit 526e49b

Please sign in to comment.