Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rosano/launchlet
Make the web yours.
https://github.com/rosano/launchlet
0data bookmarklet fission keyboard launcher local-first offline-first remotestorage single-page-app spa svelte unhosted userscripts userstyles
Last synced: 3 months ago
JSON representation
Make the web yours.
- Host: GitHub
- URL: https://github.com/rosano/launchlet
- Owner: rosano
- License: other
- Created: 2019-10-09T14:51:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T11:37:47.000Z (11 months ago)
- Last Synced: 2024-04-14T01:46:16.835Z (7 months ago)
- Topics: 0data, bookmarklet, fission, keyboard, launcher, local-first, offline-first, remotestorage, single-page-app, spa, svelte, unhosted, userscripts, userstyles
- Language: JavaScript
- Homepage: https://launchlet.dev
- Size: 2.09 MB
- Stars: 43
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Launchlet](https://launchlet.dev)
_Customize the web with JavaScript or CSS_
Launchlet is a simple way to add a name to snippets of code and run it. Inspired by [Quicksilver](https://qsapp.com/), it functions primarily via mouseless interaction and lets you access your Recipes with a few keyboard strokes. You can also use it to personalize websites with custom CSS or JavaScript. Read the guide for more details.
You can run Launchlet as a [bookmarklet](https://launchlet.dev/compose), [browser extension](https://github.com/rosano/launchlet-extension), or as a [module](https://github.com/rosano/launchlet/tree/master/os-app/dev-package) in your own project to add a 'jump to' functionality.
There is also an app where you can compose a launcher personalized with your own Recipes.
## Architecture
The project follows a [Universal folder structure](https://rosano.hmm.garden/01f71kp52knc5nnv08qr9kzj3m) and is a large collection of mostly small modules or functions that are put together using [Svelte](https://svelte.dev) and [Rollup](https://rollupjs.org). With the exception of a few 'global' or 'magic' things such as the localization function `OLSKLocalized`, most resources used by a module should be in the same folder or referenced by path name.
Routing, rendering markdown content, and serving pages is done via a Node.js server (usually configured in the *controller.js* files).
## Development Setup
(For a deeper dive, watch [the tutorial](https://rosano.hmm.garden/01f62t5yseb053m024v1mczbzy)).
Install [Node.js and npm](https://nodejs.org/en/download/), then:
```
npm run setup
```
This should create an `.env` file if there is none. If you encounter errors referring to this file, you can find missing variables in `.env-sample`.
## Running
### Start the Rollup process to build and reload automatically
```
npm run watch
```
### Start the Node.js server to view in the browser
```
npm start
```
It should be accessible at http://localhost:3000.
## Testing
See [Testing logic and interfaces](https://rosano.hmm.garden/01f7v3hk3txz5d0v9ms467x8bz) for a tutorial.
### Run logic tests
```
npm test
```
### Run interface tests
```
npm test ui
```
To filter interface test paths by string:
```
npm test ui match=ResultList
```
To filter interface test paths by JavaScript regular expressions:
```
npm test ui match='/(guide|vitrine)/'
```
## ❤️
Help me keep creating projects that are public, accessible for free, and open-source.
## License
The code is released under a [Hippocratic License](https://firstdonoharm.dev), modified to exclude its use for surveillance capitalism and also to require large for-profit entities to purchase a paid license.
## Questions
Feel free to reach out on [Mastodon](https://mastodon.online/@rosano) or [Twitter](https://twitter.com/rosano).