startit
v1.2.1
✔ Projeto de partida simples, permitindo a entrega mais rápida de projetos e/ou:
- Implantação automática de páginas do github
- Publique o lançamento do Github
Isso fornece um projeto de exemplo que automatiza tarefas com gole, incluindo:
Este projeto tem alguns requisitos que você precisa atender para compilá -lo.
Para começar a usar o projeto, você precisa cloná-lo no seu PC com o comando git, substitua [your-project] pelo nome do projeto:
git clone https://github.com/adorade/startit.git [your-project]Navegue até a pasta:
cd [your-project]Instale dependências:
yarn install Observe que as versões do módulo foram corrigidas para garantir a compatibilidade. Execute yarn outdated e atualize package.json conforme necessário.
Para começar a usá -lo, a única coisa que você precisa fazer é abrir o projeto no seu editor de código de escolha e código. Para compilar e visualizar todas as suas alterações, você tem algum comando que o ajudará. Aqui estão a lista de comandos que você deve conhecer.
Todo comando deve ser executado no diretório raiz do projeto, usando o comando gulp, como gulp cleaner ou gulp build :
| Tarefa | Descrição |
|---|---|
| mais limpo | Remova todos os arquivos compilados |
| Linter | Estilos de fiapos, scripts e arquivos de pug |
| estilos | Compilar os estilos de SASS |
| scripts | Compilar os arquivos JavaScript |
| fontes | Copiar fontes |
| Estatística | Copie arquivos estáticos |
| imagens | Otimizar imagens |
| páginas | Compilar os modelos de pug |
| servir | Inicie o servidor e observe qualquer alteração |
| construir | Construir o projeto |
| Dev | Compilar e procurar mudanças |
| implantar | Implante arquivos nas páginas do GitHub |
| liberar | Publique o lançamento do Github |
| padrão | Tarefa de gole padrão |
| cheques | Verifique a configuração do Gulp |
| ajuda | Imprimir mensagem de ajuda |
Run gulp --tasks para ver todas as tarefas disponíveis.
Se você está em desenvolvimento, o comando gulp dev é a melhor escolha para você. Vá para a pasta do projeto no console e execute gulp dev , ele compilará o projeto e iniciará um servidor que atualize toda vez que você alterar algo no código.
Gulp estará observando mudanças e lhe dirá como acessar o projeto a partir de URL local e público.
Todo navegador que aponta para esse URL será atualizado automaticamente. Como um recurso extra para o objetivo de teste, qualquer interação em um navegador será refletida sobre quaisquer outros. Experimente em um telefone, tablet e PC ao mesmo tempo.
O projeto tem uma estrutura muito simples e flexível. Se o local padrão para qualquer arquivo ou diretório precisar ser movido, certifique -se de atualizar para a nova posição no arquivo tool/util/config.js .
├── dist - > All the compiled files will be placed here (Production)
├── logs - > Logs files
├── src - > Source files for the project
│ ├── es6 - > Scripts
│ ├── fonts - > Fonts
│ ├── images - > Images
│ ├── scss - > Sass
│ ├── static - > Favicons...
│ ├── vendors - > Vendors folder for all the dependencies
│ └── views - > Templates directory for Pug files
├── test - > Tests Files
├── tmp - > All the compiled files will be placed here (Development)
├── tools - > Project tools and configuration
│ ├── build - > files for build
│ ├── tasks - > tasks files for gulp
│ └── util - > config and options for project
├── package.json - > NodeJS configuration file
├── gulpfile.esm.js - > Gulp tasks
├── README.md - > README
└── ... config files for packages Todos os arquivos nas pastas dist e tmp serão gerados automaticamente pelas diferentes tarefas quando o projeto compilar. Certifique -se de não modificar nenhum arquivo manualmente nessas pastas, pois as alterações serão substituídas no processo de compilação.
Este projeto tem algumas opções de configuração agradáveis para atender a todas as necessidades. Para configurar, você precisa editar os seguintes arquivos e alterar qualquer valor necessário:
tool/util/banner.js - Banner para scripts e arquivos de estilostool/util/config.js - Configuração do projetotool/util/options.js - opções para plugins Após cada alteração que você fez, verifique com gulp checks se tudo estiver em ordem e não há erros.
Todos os aspectos desta configuração são descritos no arquivo para que você saiba as opções.
Execute no modo de desenvolvimento de alta carga ao vivo:
yarn run start
# or
gulp
# or
gulp dev Navegue para http://localhost:1234/ ou o URL External se acessar de outro dispositivo.
Encontre a lista completa de tarefas:
gulp -T
# or
gulp -T --tasks-depth 0 Defina NODE_ENV para production para que as tarefas do Gulp produza o código final, ou seja, os arquivos minimizem e desative a geração do SourCemap.
yarn run build
# or
gulp build --production Defina NODE_ENV para production manualmente, dependendo do seu sistema operacional:
Linux/Mac OS:
NODE_ENV=production
gulp build (ou embutido NODE_ENV=production gulp build )
Windows PowerShell:
$ env: NODE_ENV = " production "
gulp buildLinha de comando do Windows Legacy:
set NODE_ENV = production
gulp build Para implantar automaticamente seu projeto nas páginas do GitHub e disponibilizá-lo em https://[your-username].github.io/[your-project-name] use:
yarn run deploy
# or
gulp build --production && gulp deployPara publicar o lançamento para o uso do GitHub:
yarn run release
# or
gulp releaseEste projeto está licenciado sob a licença do MIT
