create-preview-skyline
v1.2.2
Published
Comando para criar um projeto Prévio de Telas Interativas
Readme
🎭 Create Preview Skyline
Uma ferramenta de linha de comando (CLI) para criar rapidamente um novo projeto de prévia de empreendimento para a Skyline Produções e Inovação.
Este scaffold gera um projeto Next.js completo, pré-configurado com as tecnologias e a estrutura padrão utilizadas pelo Setor de Experiências.
🚀 Uso Rápido
Para criar um novo projeto, execute o seguinte comando no seu terminal e siga as instruções:
npx create-preview-skylineO CLI fará uma série de perguntas para personalizar o novo projeto.
📋 O que ele faz?
Ao executar o comando, a ferramenta irá solicitar as seguintes informações:
- Nome do Projeto: O nome do diretório e do projeto (em formato
kebab-case). - Descrição: Uma breve descrição para metadados e SEO.
- Cores: Cores primária e secundária para o tema do projeto.
- Menus: Opção para manter, substituir ou adicionar novos itens ao menu de navegação.
- Localização: Latitude e longitude para o mapa do Google.
- Ultratour: Link para o tour virtual do empreendimento.
Após responder, ele irá:
- Criar um novo diretório com o nome do projeto.
- Copiar o template base (
empreendimentos-base). - Substituir todas as variáveis (
{{projectName}},{{primaryColor}}, etc.) nos arquivos de texto. - Gerar a estrutura de rotas e páginas no Next.js com base nos menus definidos.
- Exibir os próximos passos para instalar as dependências e iniciar o servidor de desenvolvimento.
- Obs: As páginas de ultratour e localizacao já são padronizadas, apenas basta mudar o link do ultratour ou as coordenadas e o pin no caso da localização.
Atenção: O diretório
node_modulese arquivos de build como.nextdo template não são copiados.
🛠️ Projeto Gerado
O projeto criado utiliza as seguintes tecnologias:
- Framework: Next.js
- Linguagem: TypeScript
- Estilização: TailwindCSS
- Componentes: Material UI
Para mais detalhes sobre como executar e desenvolver o projeto gerado, consulte o README.md dentro do diretório criado.
👨💻 Desenvolvimento (do CLI)
Se você precisa fazer alterações nesta ferramenta de scaffold, siga os passos:
Clone o repositório:
git clone https://github.com/matheus-henrique-skyline/create-preview-skyline.git cd create-preview-skylineInstale as dependências:
npm installExecute localmente: Para testar suas alterações, você pode executar o CLI diretamente com o Node:
node index.js
