https://github.com/hpi-schul-cloud/schulcloud-client
Schulcloud-Verbund-Software-Client
https://github.com/hpi-schul-cloud/schulcloud-client
classroom education javascript react schools schulcloud svs-app
Last synced: 23 days ago
JSON representation
Schulcloud-Verbund-Software-Client
- Host: GitHub
- URL: https://github.com/hpi-schul-cloud/schulcloud-client
- Owner: hpi-schul-cloud
- License: agpl-3.0
- Created: 2016-10-27T12:10:11.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2026-05-05T16:05:00.000Z (about 1 month ago)
- Last Synced: 2026-05-05T16:37:14.115Z (about 1 month ago)
- Topics: classroom, education, javascript, react, schools, schulcloud, svs-app
- Language: Handlebars
- Homepage:
- Size: 217 MB
- Stars: 35
- Watchers: 12
- Forks: 13
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Schul-Cloud Client
_An implementation of the Schul-Cloud client with NodeJS and Express._
Dev: [](https://travis-ci.com/hpi-schul-cloud/schulcloud-client)
Master: [](https://travis-ci.com/hpi-schul-cloud/schulcloud-client)
## Powered By
[](https://mergify.io)
> # Deprecation Warning
> Please note that this client is going to be deprecated.
> All new frontend works is done in Vue.js and can be found here: https://github.com/hpi-schul-cloud/nuxt-client
## Requirements
* node.js 12 or later
You might take a look at the [Dockerfile](https://github.com/hpi-schul-cloud/schulcloud-client/blob/master/Dockerfile) to see some more dependencies and latest version informations.
Short setup version:
1. Clone directory into local folder
2. Go into the cloned folder and enter `npm install`
## Run
1. Start the [schul-cloud server](https://github.com/hpi-schul-cloud/schulcloud-server)
2. Go into project folder
5. run `npm run dev` to boot the application
6. go to `http://localhost:3100`
For connecting to the [SchulCloud Calendar-Service](https://github.com/hpi-schul-cloud/schulcloud-calendar) you have to set `export CALENDAR_SERVICE_ENABLED=true`.
## Theming
Add Themes to /theme directory. Call gulp and node with SC_THEME set to name of directory.
then clear build files and gulp cache with `gulp clear`
### Windows
run `set SC_THEME={themeName}` without spaces around the equal sign!
## How to name your branch and create a pull request (PR)
1. Take the Ticket Number from JIRA (ticketsystem.dbildungscloud.de), e.g. BC-999
2. Name the feature branch beginning with Ticket Number, all words separated by dash "-", e.g. `feature/BC-999-fantasy-problem`
3. Create a PR on branch develop containing the Ticket Number in PR title
4. Keep the `WIP` label as long as this PR is in development, complete PR checklist (is automatically added), keep or increase code test coverage, and pass all tests before you remove the `WIP` label. Reviewers will be added automatically.
## Testing
**Information**: Please make sure that all your changes works on [Chrome](https://www.google.de/chrome/browser/desktop/index.html) , [Firefox](https://www.mozilla.org/de/firefox/new/) and [Safari](https://www.apple.com/de/safari/)!
For html/css components please check [caniuse](https://caniuse.com/).
1. run `npm run coverage`
## Commiting
Default branch: main
1. Go into project folder
2. Checkout to develop branch (or clone for the first time)
3. Run `git pull`
4. Create a branch for your new feature named feature/BC-*Ticket-ID*-*Description*
5. Run the tests (see above)
6. Commit with a meanigful commit message(!) even at 4 a.m. and not stuff like "dfsdfsf"
7. Start a pull request (see above) to branch develop to merge your changes
## Code rules
[CSP rules](https://github.com/hpi-schul-cloud/schulcloud-client/tree/develop/docs/CSP_RULES_DEV.md)