https://github.com/lagden/boilerplate-bin
Boilerplate com Bourne Shell script, Bourne-Again Shell script e Node.js script.
https://github.com/lagden/boilerplate-bin
bash bin boilerplate nodejs sh
Last synced: 2 months ago
JSON representation
Boilerplate com Bourne Shell script, Bourne-Again Shell script e Node.js script.
- Host: GitHub
- URL: https://github.com/lagden/boilerplate-bin
- Owner: lagden
- Created: 2020-11-24T03:58:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T02:04:58.000Z (almost 2 years ago)
- Last Synced: 2025-04-03T14:15:17.847Z (about 1 year ago)
- Topics: bash, bin, boilerplate, nodejs, sh
- Language: Shell
- Homepage:
- Size: 109 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boilerplate Bin
Pode ser utilizado nos projetos:
- [Boilerplate Rest](https://github.com/lagden/boilerplate-rest)
- [Boilerplate GraphQL](https://github.com/lagden/boilerplate-gql)
- [Boilerplate Websocket](https://github.com/lagden/boilerplate-ws)
- [Boilerplate Svelte](https://github.com/lagden/boilerplate-svelte)
## Como usar
Utilize `@tadashi/boilerplate-create` para iniciar o projeto.
```
npm i -g @tadashi/boilerplate-create
boilerplate-create
```
ou
```
npx --yes @tadashi/boilerplate-create
```
E siga as instruções do prompt.
## Scripts
Índice:
- [Docker](#docker)
- [deploy](#deploy)
- [image](#image)
- [image_ci](#image_ci)
- [start](#start)
- [stop](#stop)
- [test](#test)
- [Helper](#helper)
- [fn](#fn)
- [wait](#wait)
- [Local](#local)
- [start](#start-1)
- [test](#test)
- [Node](#Node)
- [build](#build)
- [pkg.js](#pkg.js)
- [zera](#zera)
---
### Docker
#### deploy
O fluxo do **deploy**:
1. Carrega as variáveis de ambiente
2. Executa o script `image`
3. Cria o arquivo `docker-compose-{VERSION}.yml`
4. Sincroniza os arquivos com o servidor
5. Executa o `docker stack deploy` no servidor
```
Usage: deploy [options...]
Options:
-e Environment
-i Ignore build image
-h Show usage
```
#### image
Cria a imagem do projeto e faz um `push` para o **resgistry**.
```
Usage: image [options...]
Options:
-e Environment
-h Show usage
```
#### image_ci
Cria a imagem do projeto via CI/CD
```
Usage: image_ci [options...]
Options:
-e Environment
-h Show usage
```
#### start
Inicia o stack de **desenvolvimento** via **docker**.
```
Usage: start [options...]
Options:
-b Build image
-d Run containers in the background
-h Show usage
```
#### stop
Encerra o stack que foi inicializado via **docker** pelo script `start`.
#### test
Executa o teste do stack via **docker**
```
Usage: test [options...]
Options:
-s Get exit code from service
-b Build image
-h Show usage
```
### Helper
#### fn
Métodos utilizados pelos scripts.
#### wait
Esse script é para garantir que os outros serviços estejam rodando antes de iniciar a aplicação.
Veja o exemplo abaixo:
```yml
command: >
/bin/ash -c "
bin/helper/wait db:3456;
node server
"
```
A aplicação só irá iniciar quando o serviço `db` estiver respondendo na porta `3456`.
### Local
#### start
Carrega as variáveis de ambiente de **desenvolvimento** e inicia a aplicação.
```
Usage: $0 [options...]
Options:
-e Environment
-b Build and run the application
-i Ignore run
-h Show usage
```
#### test
Carrega as variáveis de ambiente de **teste** e executa o teste da aplicação.
### Node
#### build
Esse script é utilizado geralmente em aplicações frontend.
Ele executa o `build` da aplicação dentro do **Dockerfile**
#### pkg.js
Atualiza para última versão todas as `dependencies` e `devDependencies` do arquivo **package.json**.
Mas é preciso que seja instalado novamente via **npm**, **yarn** ou **pnpm**.
#### zera
Limpa todos os pacotes e reinstala novamente via **npm**, **yarn** ou **pnpm**.
```
Usage: $0 [options...]
Options:
-m, --manager Package manager: npm (default), yarn or pnpm
-s, --shame Shamefully hoist (only pnpm)
-h, --help Show usage
```
---
## License
MIT © [Thiago Lagden](https://github.com/lagden)