Pfeil

This is a simple app for studying things with flashcards, particularly foreign languages. The stable(ish) version of the site is hosted here and the dev version is available here. The dev version has the latest features, but is somewhat less stable, so please export and backup your decks often!

Development

The site and all of its assets are served out of the flat directory dist.

Creating an instance of the site

Sourcing the create-pfeil-env.sh script will create a development environment for you using Miniconda:

source create-pfeil-env.sh

Once you are in the pfeil-dev environment, you can run

make build

to built all of the Typescript code into dist/bundle.js which will copy all static assets into the dist directory automatically.

⚠️ NOTE: You'll need to re-run make build each time you change the source code. Running make clean before make build will create a new dist directory, which may be helpful when debugging.

Once built, the site can be served directly out of dist with a file server like the simple Python HTTP server:

cd dist
python3 -m http.server

The site will be viewable at the local URL provided by python3 -m http.server (typically http://[::]:8000/). Visit that URL and check out your instance of the site!

You can also run:

npm run develop

for a live Node + Typescript + Webpack development server that automatically updates its deployment as you make changes to Typescript files.

Acknowledgments

Emojis taken from Openmoji. Open icons taken from uxwing.