MCGallaspy / wordweaver

WordWeaver: A tool for creating interactive verb conjugation web applications

WordWeaver

A web app for visualizing data from WordWeaver

This is an Angular web application for visualizing data from WordWeaver.

⚠️ 🚧 This repo is currently under construction 🚧 ⚠️

Table of Contents

• WordWeaver
  • Table of Contents
  • Background
    • Features
  • Install
  • Usage
  • Adapting to your languages
  • Maintainers
  • Contributing
    • Contributors
  • License

Background

This is a tool for creating interactive conjugation tools for your language.

Features

• It is fully i18n compliant and customizable using ngx-translate and POEditor. The interface is already in English and French.
• Functions offline (including your conjugation data!) thanks to PouchDB
• Built for mobile (PWA support)
• Totally themable

Install

If using with a new language, it is recommended to clone the repo.

$ git clone https://github.com/roedoejet/wordweaver.git
$ cd wordweaver
$ npm install

Then, you can create a new repo on GitHub and reset the origin remote to your new repo:

git remote set-url origin https://github.com/<yourusername>/<yourrepo>

Then, add a new repo and set the url to this:

git remote add ww https://github.com/roedoejet/wordweaver.git

That way, you can make changes in your repo, push them to your origin, but still pull new changes to the gui using git pull ww main

Usage

After installing, just start the app to run locally:

$ npm start

Adapting to your languages

1. Clone and add remote 'ww'
2. npm install
3. Replace the svg in the shared logo component
4. Edit config
5. Add any languages to assets/i18n

Maintainers

@roedoejet.

Contributing

Feel free to dive in! Open an issue or submit PRs.

This repo follows the Contributor Covenant Code of Conduct.

Running the test suites

To execute the unit test suites, run:

npm run-script test      # regular mode
npm run-script ci:test   # alternative, headless mode

To execute the end-to-end test suite, you must first install Playwright by running:

npx playwright install --with-deps

and then you can execute the suite with:

npm run-script e2e

Contributors

This project exists thanks to all the people who contribute.

License

MIT © Aidan Pine