DocsPrimeiros passos
Instalação
Requisitos
| Requisito | Por que |
|---|---|
| Python 3.12+ | requires-python em pyproject.toml; nenhum compilador C necessário, Windows incluído |
| uv | cria o projeto, instala seus pacotes e executa o Nexy |
| Node.js 18+ | apenas para uma estrutura de cliente (React, Vue, Svelte, Solid, Preact) |
Um projeto sem uma estrutura de cliente não precisa de Node.js.
Instale uv primeiro
uvx não é uma ferramenta separada: ela vem com uv, então instale uv antes de qualquer coisa.
# 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"
Verifique com uv --version e uvx --version.
Crie um projeto
uvx nexy new my-app
uvx executa o Nexy em um ambiente temporário e não deixa nada para trás. Isso é suficiente para criar um projeto (new, init) e nada mais: o ambiente temporário contém Nexy e nenhum outro pacote. nexy new cria o próprio ambiente virtual do projeto, .venv, e instala seus pacotes lá.
nexy new my-app faz quatro perguntas: roteador (baseado em arquivo ou modular), tipo de projeto (web ou API), framework cliente, ORM. A instalação das dependências Python e do Node é executada com uma linha por etapa e sua duração. Consulte CLI.
Ignore as solicitações com um modelo registrado:
uvx nexy new my-app --template <name>
Trabalhe dentro do ambiente virtual do projeto
Todos os outros comandos (nexy dev, nexy build, nexy migrate...) devem ser executados dentro do ambiente virtual do projeto. É aí que residem seus próprios pacotes: seu ORM, suas bibliotecas e o Nexy com o qual o projeto foi construído. Fora dele, um projeto que precisa de sqlmodel falha com ModuleNotFoundError: No module named 'sqlmodel'.
Ative-o uma vez por terminal, na pasta do projeto:
| Concha | Comando |
|---|---|
| Powershell, cmd (Windows) | .venv\Scripts\activate |
| macOS, Linux | source .venv/bin/activate |
O prompt então começa com (.venv). A partir daí:
cd my-app.venv\Scripts\activate # Windows; on macOS and Linux: source .venv/bin/activatenexy dev
Abra http://localhost:3000.
Para pular a ativação, deixe uv fazer isso com um comando: uv run nexy dev.
Adicione Nexy a um projeto existente
Execute-o a partir do ambiente virtual do projeto, com Nexy entre seus pacotes (uv add nexy):
nexy init