Skip to main content

Getting Started

Development Setup​

Note: Please don't use yarn !!! We decided to use npm across all of our repositories.

In order to run this client, you need to have the legacy-client and schulcloud-server set up and running. See for documentation on how to do that in the respective repositories.

Start the Server​

  1. Clone the repository

    git clone git@github.com:hpi-schul-cloud/nuxt-client.git

  2. Install the required dependencies:

    npm ci

  3. Start the development server:

    npm run serve

    By default the server will listen on the URL http://localhost:4000

Unit Tests​

# Run all (unit) tests
npm run test

Lint​

npm run lint

Editor Setup​

We are using Visual Studio Code as our default deveopment-IDE. In /.vscode you can find two templates to setup your IDE:

  • launch.default.json (copy its content and us it in launch.json)
  • settings.default.json (copy its content and us it in settings.json)

For a list of recommended Visual Studio Code extensions please refer to extensions.json.