Sobre o projeto

Windrift é um framework JavaScript de código aberto para escrever narrativas mutáveis e histórias interativas em hipertexto. Ele foi usado para criar obras como Harmonia, Stone Harbor, The Ballroom, The Imposter e uma tradução para o português de Stone Harbor. O projeto é construído sobre o Next.js e escrito em TypeScript, operando como uma única aplicação Next.js que pode hospedar múltiplas histórias. Os autores podem usar recursos e opções de implantação do Next.js, incluindo hospedagem via Vercel. Como o código principal do Windrift é incluído em cada repositório de história, os autores podem modificar ou alterar o comportamento fundamental da biblioteca em seus próprios projetos. O repositório oferece um fluxo de trabalho de desenvolvimento local usando Node.js, recomendando o Node Version Manager com o Node 22. A instalação é feita por meio do npm, e há comandos disponíveis para criar uma nova história usando um identificador de história e para executar o ambiente de desenvolvimento local. Comandos adicionais, incluindo opções de implantação, estão documentados no manual oficial do Windrift. A documentação é fornecida por meio de um manual oficial publicado continuamente, que é ele mesmo escrito como uma história do Windrift. O manual inclui histórias de exemplo que vão do uso básico ao avançado, e o Windrift Playground oferece demonstrações adicionais com código-fonte disponível para histórias de exemplo. O projeto também inclui testes de integração por meio de fluxos de trabalho com Playwright.