Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fermyon/finicky-whiskers
Demo app
https://github.com/fermyon/finicky-whiskers
demo wasm
Last synced: 2 months ago
JSON representation
Demo app
- Host: GitHub
- URL: https://github.com/fermyon/finicky-whiskers
- Owner: fermyon
- License: apache-2.0
- Created: 2022-04-04T22:35:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T21:27:08.000Z (7 months ago)
- Last Synced: 2024-04-16T12:05:29.605Z (6 months ago)
- Topics: demo, wasm
- Language: Ruby
- Homepage: https://www.finickywhiskers.com
- Size: 23 MB
- Stars: 31
- Watchers: 13
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
To learn more about "The World's Most Adorable Manual Load Generator", Finicky Whiskers, and the technical details under the covers, you should read the four-part blog post series accompanying the project:
1. [The World's Most Adorable Manual Load Generator](https://www.fermyon.com/blog/finicky-whiskers-part-1-intro)
2. [Serving the HTML, CSS, and static assets](https://www.fermyon.com/blog/finicky-whiskers-part-2-fileserver)
3. [The Microservices](https://www.fermyon.com/blog/finicky-whiskers-part-3-microservices)
4. [Spin, Containers, Nomad, and Infrastructure](https://www.fermyon.com/blog/finicky-whiskers-part-4-infrastructure)
Finicky Whiskers is comprised of a handful of microservices.
- [redirect](./redirect/README.md)
- [reset](./reset/README.md)
- [scoreboard](./scoreboard/README.md)
- [session](./session/README.md)
- [site](./site/README.md)
- [tally](./tally/README.md)
## Prerequisites
You'll need Spin [v0.4.1](https://github.com/fermyon/spin/releases/tag/v0.4.1)
to run the site locally.
You will also need the following to build and run the components:
```
$ brew tap kateinoigakukun/wasi-vfs https://github.com/kateinoigakukun/wasi-vfs.git
$ brew install kateinoigakukun/wasi-vfs/wasi-vfs
$ brew install npm
$ brew tap tinygo-org/tools
$ brew install tinygo
$ rustup target add wasm32-wasi
```
It is expected that Rust will be installed already. Do not use Homebrew to install Rust,
it will cause errors.
## To Build
This will by default build all microservices per the `Makefile` in their directories:
```console
spin build
```
You may also build a particular microservice by navigating into its directory
and running `make build` or from the root of this repo via
`make build-` e.g.:
```console
make build-session
```
## To Run
The following command will serve the Finicky Whiskers site locally:
```console
spin up --sqlite @highscore/migration.sql
```
This will run the game at [http://127.0.0.1:3000](http://127.0.0.1:3000)
## To Test
The following command will serve the site and then run the integration test
as seen [here](./tests/test-server.sh):
```console
make test-server
```
## Development Notes
For working on the game UI (styles, etc):
Recompiling Assets:
```console
cd site
npm i
npm run styles
```
To just run the UI locally (without the other services) use [Parcel](https://parceljs.org/features/development/) via `npm run dev` and then view the site at [localhost:1234](http://localhost:1234/)