generated from projects/testosmaximus
47 lines
862 B
Markdown
47 lines
862 B
Markdown
# funkyFlaskTest (npm module template)
|
||
|
||
Template for creating npm modules using TypeScript + Vite.
|
||
The actual module is in `source/`. It builds and publishes from `build/`.
|
||
|
||
---
|
||
|
||
## 🔧 Scripts
|
||
|
||
### `init.sh`
|
||
|
||
```bash
|
||
./init.sh --name @your/module --version 0.0.1
|
||
````
|
||
|
||
* Sets name and version in `source/package.json`
|
||
* Prompts if missing
|
||
* Installs `jq` if needed
|
||
* Deletes itself if `--once` is used
|
||
|
||
---
|
||
|
||
### `push`
|
||
|
||
```bash
|
||
./push
|
||
```
|
||
|
||
* Copies `source/` to `build/`
|
||
* Builds with `tsc`
|
||
* Publishes to your Gitea npm registry using `.env` and `$NPM_TOKEN`
|
||
|
||
---
|
||
|
||
### `reset.sh`
|
||
|
||
```bash
|
||
./reset.sh --confirm @your/module
|
||
```
|
||
|
||
* Resets the repo to the base template from Gitea
|
||
* Requires confirmation to prevent accidental nukes
|
||
|
||
---
|
||
|
||
This is a minimal, non-standard layout meant for cleaner module management and publishing. Use it, or don’t. It works.
|