Seedlingo

Modern mobile multi-language literacy


A first-language digital learning tool for adults

Documentation
·
Contributing

Table of contents

• What is Seedlingo
• Get started
• Community
• Code of conduct
• Contributing
• License

What is Seedlingo

Seedlingo is a digital language learning tool
targeting adults learning to read their native language.

A teacher or content developer
can prepare tailored units of exercises
from Seedlingo’s templates
to provide skill-adjusted assignments
to a fluent listener
learning to read the language.

Current exercise types are:

• multiple-choice
  • select text by audio cue
  • select text by short phrase/synonym/explanation
• matching
  • match text to audio cue 4-by-4
  • match text to phrase/synonym/explanation 3-by-3
• cloze
  • select text that matches the missing bit in a sentence
  • select multiple text fragments
    that match multiple missing bits in a sentence
• comprehension
  • read a short paragraph or two,
    then answer questions about the the text,
    before practicing newly introduced words or fragments
    using multiple-choice or matching,
    then finally review the original text

Developing a content editor is high on the list of priorities.

Seedlingo was originally developed as
立爱种字 LiAiZhongzi.com
from ideas by 立爱教育 Li Ai Education,
to help Putonghua speaking adults
learn to read simplified Chinese characters.

To try the Android app, download version 1.5.2 or check the release history
for a more recent version.
Download to your phone, then install.
You may have to enable the setting “Install from unknown sources”
before your phone will allow the installation.

There is also an English language version available for demonstration purposes
online at en.seedlingo.app
or downloadable for Android.

Get started

Prerequisites

• Install git if not present.

• Install Node.js, which includes
  npm (Node Package Manager).

  • If you do not use Volta,
    use the version specified in the volta-section of package.json
    when installing Node.js according to your preference.

  • If you do use Volta,
    the package.json-specified Node version
    will automatically be installed and used
    when commands are executed.

Development setup

Follow these steps to set up a development or test environment
on Ubuntu 22.04 LTS or equivalent.

Clone the Seedlingo repository

git clone git@github.com:nodepa/seedlingo.git

Navigate to repo

cd seedlingo/app

Install packages

npm install

Start the app in local preview mode

npm start   # Then visit http://localhost:4173 in your web browser

Development mode

You can also run Seedlingo in development mode.

npm run dev   # Then visit http://localhost:5173 in your web browser

Run full test suite

Executing the script test will trigger the scripts for

• install
• lint
• testcoverage
• test:e2e (i.e. end-to-end)

npm test

Misc

Play around with your own content
by replacing the content/ folder (parallel to the app/ folder)
with your own content.
See the Seedlingo documentation
about formats.

Community

Engage the community and ask questions
in Seedlingo discussions.
Please stop by and say hi.

Code of conduct

Please help us keep the Seedlingo community open and positive.
Participate in the spirit of the
Seedlingo Code of Conduct
and the GitHub Community Guidelines.

Contributing

We would love to receive your contributions to Seedlingo.
Read through our contributing guidelines
and get working on it!

License

The Seedlingo project,
EXCEPT all material in the content/ folder,
is licensed to the public under the MIT License.

The Seedlingo project’s content/ is licensed to the public under the
Creative Commons Attribution-ShareAlike 4.0 International Public License.

By contributing to the Seedlingo project,
you agree to license your contribution to the public under these terms,
and affirm that you have the right to do so.