DokumentasiLangkah pertama
Instalasi
Persyaratan
| Persyaratan | Mengapa |
|---|---|
| Python 3.12+ | requires-python di pyproject.toml; tidak diperlukan kompiler C, termasuk Windows |
| uv | membuat proyek, menginstal paketnya dan menjalankan Nexy |
| Node.js 18+ | hanya untuk kerangka klien (React, Vue, Svelte, Solid, Preact) |
Sebuah proyek tanpa kerangka klien tidak memerlukan Node.js sama sekali.
Instal uv terlebih dahulu
uvx bukan alat terpisah: ia disertakan dengan uv, jadi instal uv sebelum melakukan hal lain.
# macOS and Linuxcurl -LsSf https://astral.sh/uv/install.sh | sh # Windows (PowerShell)powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
Periksa dengan uv --version dan uvx --version.
Buat proyek
uvx nexy new my-app
uvx menjalankan Nexy di lingkungan sementara dan tidak meninggalkan apa pun. Itu cukup untuk membuat sebuah proyek (new, init) dan tidak lebih: lingkungan sementara menampung Nexy dan tidak ada paket lainnya. nexy new membuat lingkungan virtual proyek itu sendiri, .venv, dan menginstal paket-paketnya di sana.
nexy new my-app menanyakan empat pertanyaan: router (berbasis file atau modular), jenis proyek (web atau API), kerangka klien, ORM. Instalasi dependensi Python dan Node kemudian dijalankan dengan satu baris per langkah dan durasinya. Lihat CLI.
Lewati petunjuk dengan templat terdaftar:
uvx nexy new my-app --template <name>
Bekerja di dalam lingkungan virtual proyek
Setiap perintah lainnya (nexy dev, nexy build, nexy migrate...) harus dijalankan di dalam lingkungan virtual proyek. Di situlah paket Anda berada: ORM Anda, perpustakaan Anda, dan Nexy yang digunakan untuk membuat proyek. Di luar itu, proyek yang membutuhkan sqlmodel gagal dengan ModuleNotFoundError: No module named 'sqlmodel'.
Aktifkan sekali per terminal, dari folder proyek:
| cangkang | Perintah |
|---|---|
| PowerShell, cmd (Windows) | .venv\Scripts\activate |
| macOS, Linux | source .venv/bin/activate |
Prompt kemudian dimulai dengan (.venv). Dari sana:
cd my-app.venv\Scripts\activate # Windows; on macOS and Linux: source .venv/bin/activatenexy dev
Buka http://localhost:3000.
Untuk melewati aktivasi, biarkan uv melakukannya untuk satu perintah: uv run nexy dev.
Tambahkan Nexy ke proyek yang sudah ada
Jalankan dari lingkungan virtual proyek, dengan Nexy di antara paketnya (uv add nexy):
nexy init