https://github.com/nichoth/template-ssc
Template for ssc projects
https://github.com/nichoth/template-ssc
Last synced: 4 months ago
JSON representation
Template for ssc projects
- Host: GitHub
- URL: https://github.com/nichoth/template-ssc
- Owner: nichoth
- Created: 2023-01-01T23:11:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T23:36:18.000Z (over 3 years ago)
- Last Synced: 2025-01-13T17:24:37.305Z (over 1 year ago)
- Language: JavaScript
- Size: 124 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# template
A template for ssc projects, using a preferred dev environment -- [standardx](https://www.npmjs.com/package/standardx), [git-hooks-plus](https://www.npmjs.com/package/git-hooks-plus), and typescript via a [jsconfig.json](jsconfig.json) file
This project is an example of using `ssc` without a `build` script in `socket.ini`. This will simply copy all files from an input directory to an output directory. So the build process is two discrete steps -- first build a static website as normal to the `public/` directory, then use `ssc` to build a binary app from the static website, which goes in the `dist/` folder.
## use
Use github's 'template' button, or clone this then `rm -rf .git && git init`. Then `npm i && npm init` and edit the source code in `src/main` and `src/render`.
## featuring
* lint via [standardx](https://www.npmjs.com/package/standardx) -- `npm run lint`
* git hooks via [git-hooks-plus](https://www.npmjs.com/package/git-hooks-plus) -- lint the code prior to `push`
* tests via [tapzero](https://www.npmjs.com/package/tapzero)
* `import` syntax / ES6 modules
* check the number of dependencies before you increase the version number -- `npm run preversion` -- see [@nichoth/check-max-deps](https://github.com/nichoth/check-max-deps)
* view library [Tonic](https://tonicframework.dev/)
## npm scripts
### run
```
npm start
```
### test
```
npm test
```
### build
```
npm run build
```