https://github.com/allnulled/litestarter
https://github.com/allnulled/litestarter
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/allnulled/litestarter
- Owner: allnulled
- Created: 2024-12-20T19:18:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-23T15:08:17.000Z (over 1 year ago)
- Last Synced: 2024-12-28T12:20:17.978Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://npmjs.com/@allnulled/litestarter
- Size: 11.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# litestarter
Little starter for apps with Vue.js (v2) + Win7.css + Importer + Reloader + Socket-io.client.
## Installation
```sh
npm i -g @allnulled/litestarter
```
## Usage
This will start a project in the current directory.
```sh
litestarter .
```
To serve the static files do:
```sh
sh serve.sh
```
To reload automatically on changes do:
```sh
node reloader.js
```
You can create new components simply with:
```sh
node create-component.js
```
## Features
- Module loading bar (with [`importer`](https://github.com/allnulled/importer))
- Import modules system (with [`importer`](https://github.com/allnulled/importer))
- Instantiable logger (with [`basic-logger`](https://github.com/allnulled/basic-logger))
- Instantiable checker (with [ensure](https://github.com/allnulled/ensure))
- Filesystem polyfill (with [ufs](https://github.com/allnulled/universal-file-system))
- SQLite polyfill with:
- [sql.js](https://sql.js.org/#/)
- [sqlite-polyfill](https://github.com/allnulled/sqlite-polyfill)
- [sqlite-data-system](https://github.com/allnulled/sqlite-data-system/))
- Windows 7 styles (with [win7.css](https://khang-nd.github.io/7.css/))
- Custom bundler (with [vuebundler](https://github.com/allnulled/vuebundler) and [htmlbundler](https://github.com/allnulled/htmlbundler))
- Automatic refresher
## Files in docs
The `docs` folder contains the base project of `litestarter`. It contains files like:
- `bundle.js`: compiles the Vue.js v2 components, JavaScript and CSS to `dist/*.*`. Can run with `npm run build`.
- `bundlelist.components.js`: provides the list of components.
- `bundlelist.js.js`: provides the list of components.
- `bundlelist.css.js`: provides the list of components.
- `create-component.js`: creates a new component from the templates on `src/components/prototype`. Can run with `npm run create-component`.
- `package.json`: the package.json of the front-end project itself. Change it to fit your requirements.
- `reloader.js`: starts a socket-server and watching changes on files to emit the order to refresh to the browser. Can run with `npm run reloader`.
- `serve.sh`: starts an http server providing access to the application statically. Can run with `npm run serve`.
Note that `reloader.js` does NOT compile automatically the `dist` application. You have to `npm run build` manually.
Note also that `src/index.js` is controlling the load depending on the environment.
- In `"test"` it loads file by file by default.
- In `"production"` it laods directly `dist/app.js` and `dist/app.css` (which also contain `components.*`).
- To update `dist/app.*` you must run `npm run build` manually
# Demo
Go to:
- [https://allnulled.github.io/litestarter/](https://allnulled.github.io/litestarter/)