Começando

📌 Você pode assistir um tutorial no nosso Canal do Youtube.

Crie aplicações javascript full-stack em segundos usando npx para gerar os arquivos do seu projeto usando o template mais recente.

🔥 A versão mínima necessária do node.js para o modo de desenvovimento é 12.12.0.

⚠ Se o diretório em que você está contém espaços, você usa Windows e o npx der erros, leia sobre o bug conhecido do npx.

Troque project-name com o nome do seu projeto e rode o comanto abaixo para começar um projeto:

npx create-nullstack-app project-name

Troque o diretório para a pasta gerada:

cd project-name

Instale as dependências:

npm install

Inicie a aplicação em modo de desenvolvimento:

npm start

Entendendo os arquivos gerados

As seguintes pastas e arquivos serão gerados:

index.js

Este é o ponto de entrada do Webpack.

Normalmente, você não precisará mexer neste arquivo, mas é um lugar conveniente para importar dependências globais como frameworks CSS.

src/

Esta pasta contêm o código fonte da sua aplicação.

src/Application.njs

Este é o arquivo principal da sua aplicação.

✨ Saiba mais sobre a extensão de arquivo njs.

A função start será automaticamente chamada uma vez que você rode npm start, use a para preencher o contexto do seu servidor com coisas como banco de dados, configurações, e segredos.

✨ Saiba mais sobre a inicialização da aplicação.

src/Application.scss

Este é um arquivo vazio só para demonstrar que você pode usar SCSS com Nullstack.

É uma boa prática importar um arquivo de estilo em um componente com o mesmo nome.

✨ Saiba mais sobre estilos.

public/

Todo arquivo aqui ficará disponível para qualquer um na raíz do domínio.

Por padrão create-nullstack-app gera os ícones necessários para o seu manifest.json e imagens para meta tags OG.

✨ Saiba mais sobre o manifest.json.

Tenha certeza de trocar estas imagens pela identidade do seu projeto.

.development/

Este é o resultado compilado da sua aplicação em modo de desenvolvimento.

🔥 Não toque nesta pasta

.production/

Este é o resultado compilado da sua aplicação em modo de produção.

🔥 Não toque nesta pasta

✨ Saiba mais sobre como fazer deploy de aplicação Nullstack.

Bug conhecido do npx

Avisado em issues do npx como #100, #110 e #143, ele tem um erro ao tentar resolver o caminho para sua pasta de cache quando este contém espaços.

Se isso ocorrer com você, nossas recomendações são:

  • Usando baixado como normalmente faria com npm:

    npm i -g create-nullstack-app
    create-nullstack-app project-name
    
  • ou, mudar o diretório da pasta de cache, como dito aqui e aqui:

    • Se deseja manter o uso do espaço, subtitua PrimeiroNome pelo usado no seu caminho e rode:
    npm config set cache "C:\Users\PrimeiroNome~1\AppData\Roaming\npm-cache" --global
    
    • ou, usando outro caminho sem espaços:
    npm config set cache C:\tmp\nodejs\npm-cache --global
    

Próximo Passo

⚔ Crie seu primeiro componente renderizável.