Skip to content

krazkidd/snail-tail

Repository files navigation

Snail Tail

Run (or walk!) from an ephemeral adversary of your choice. Move your body to put distance between you and them or face an uncertain threat...

Just kidding! You can opt out just as easily as you opt in. We just want you to make physical activity a routine.

Try the live app now!

Project hosted at: https://github.com/krazkidd/snail-tail

License: AGPLv3 (see LICENSE.md file)

Features

  • Start or stop the chaser at will
  • Customizable user and chaser avatars
  • Dark mode

Development

First and foremost, this is an Ionic app, so we use Ionic tooling which wraps Angular tooling. Capacitor tooling is used for mobile targeting.

Setup

To install dependencies:

npm install

To install the Angular CLI, follow these instructions or simply run:

npm install -g @angular/cli

To install the Ionic CLI, follow these instructions or simply run:

npm install -g @ionic/cli

Then, to run the app in dev mode:

ionic serve

The server listens on http://localhost:8100/.

Deployment (Web)

Ionic (with Angular) apps run on the client side.

Build

To generate the site files, run:

ionic build --prod

Then simply copy the contents of the www/ directory to your host. An index.html entry point is provided.

Hosting

GitHub Pages (free)

Create a gh-pages (orphan) branch and commit the generated files. You may need to configure this branch to be your publishing source, but after that, deployment is automatic.

Attributions

The running shoe favicon (src/assets/icon/favicon.ico and accompanying files) and other emojis are used under the CC-BY 4.0 license from the twemoji project.