Get started

If you want to try out Seedlingo on your local system, want to develop your own content, or want to contribute to Seedlingo, this should get you up and running.

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

cd seedlingo/app

Install packages

npm install

Start the app in local demo

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

Start the app in dev mode with hot reloading

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

Run full test suite

This command combines the scripts for:

  • install
  • lint
  • test:unit:coverage
  • 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.