https://github.com/vwapplications/vwapp-utilities
Funções uteis para projetos em javascript.
https://github.com/vwapplications/vwapp-utilities
Last synced: 17 days ago
JSON representation
Funções uteis para projetos em javascript.
- Host: GitHub
- URL: https://github.com/vwapplications/vwapp-utilities
- Owner: VWApplications
- Created: 2020-04-18T22:23:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T02:14:51.000Z (about 2 years ago)
- Last Synced: 2025-03-01T13:04:36.650Z (over 1 year ago)
- Language: JavaScript
- Size: 749 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vwapp-utilities
Funções uteis para projetos em javascript..
[](https://www.npmjs.com/package/vwapp-utilities) [](https://standardjs.com)
## Instalação.
```bash
npm install --save vwapp-utilities
```
## Uso
```jsx
```
## Contribuir
#### 1. Como rodar o ambiente de desenvolvimento:
Rode os dois comandos abaixo em 2 abas diferentes. O primeiro comando vai ficar observando modificações do seu pacote e o segundo
comando consome essas modificações no html.
No diretorio raiz rode o npm start
```
npm start
```
No diretorio example rode o npm start.
```
cd example
npm start
```
#### 2. Como instalar ou remove um pacote.
Para instalar um novo pacote tem que fazer o seguinte comando:
```
npm install --save nome-do-pacote
```
Com ele instalado tem que coloca-lo no package.json
```json
"dependencies": {
"nome-do-pacote": "^versao",
"...": "..."
},
"peerDependencies": {
"nome-do-pacote": "^versao",
"...": "..."
}
```
Com isso, teste se esse pacote está sendo utilizado, caso não rode o npm install e reinicie os servidores.
#### 3. Publicar no npmjs
1. Crie uma conta no https://www.npmjs.com/
2. Execute no terminal ```npm login``` e logar com as credenciais criadas no npmjs
3. Execute ```npm publish``` na pasta do projeto
4. E então use em outros projetos!
#### 4. Publicar documentação github pages
Rode o comando para criar uma pagina com a build do projeto example do seu repositório.
```
npm run deploy
```
#### 5. Atualizando um projeto.
Versões: MAJOR.MINOR.PATCH
* **MAJOR**: Versão em que fizeste modificações incompatives com versões anteriores, ou seja, que irá quebrar algo anteriormente feito.
* **MINOR**: Quando você adicionar funcionalidades que são compativeis com versões anteriores.
* **PATCH**: Correções de erros/bugs compativeis com versões anteriores.
## Licença
MIT © [VictorDeon](https://github.com/VictorDeon)