This is GitHub Repository is no longer being support or maintained. This repository will be deprecated on 03/01/2021.

SSDN

Open source application that provides a non-proprietary, vendor-neutral solution for facilitating data interchange between educational institutions and education technology providers.

This is the root project for the SSDN. Head to the corresponding sub-project README to know more.

• SSDN Core
• SSDN Administration Panel
• SSDN Browser Collection Agent
• SSDN CLI (installation and upgrade)

Additional documentation

• API usage
• Architecture design
• Testing methodology
• Security considerations

Setup

The root project uses Yarn workspaces and Lerna to manage its sub-projects.

You can setup every sub-project individually by following the instructions given in the corresponding README, or you can bootstrap all of them at once by running:

lerna bootstrap

or

yarn install

Other useful commands you can run on all sub-projects at once are:

yarn build          # generates a production-ready bundle
yarn start          # starts a live-reloading development environment
yarn lint           # runs typescript linter (ts-lint)
yarn check-types    # runs typescript compiler (tsc)
yarn release        # generates a new release in a .zip file and stores it in `/releases`

Creating a new release

Since the main project is managed by Lerna, you can use one of its commands to update all the sub-packages at the same time. For example, to bump the project to version 1.2.3, you can run:

lerna version 1.2.3

Keep in mind that, by default, this command will commit the changes, generate a version tag and push everything to the repository. If you don't want that, check out Lerna's documentation to know more about its different options.

After the version is set, you can then run:

yarn release

This will generate a file named ssdn-1.2.3.zip in the releases folder that is suitable for installation. Check out the installation instructions for more details.