Skip to content
Schul-Cloud Core Server
JavaScript HTML Other
Branch: develop
Clone or download
Latest commit 41efcbc Sep 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add autolabler for WIP Apr 8, 2019
.idea rebase Jan 4, 2017
backup/setup updated timestamp in migrations Sep 18, 2019
config Merge branch release/19.4.0-r2 into master Sep 3, 2019
migrations write migration Sep 17, 2019
public WIP [ci-skip] Feb 8, 2017
src Merge tag '19.5.4' into develop Sep 18, 2019
test Merge branch 'develop' into feature/sc-1334-fix-server-warnings Sep 11, 2019
.codacy.yaml Merge branch 'develop' into OSC-19/Willkommens-Dokumente Aug 23, 2019
.dockerignore ignore node modules in dockerignore Jul 22, 2019
.editorconfig tabs Oct 21, 2016
.eslintrc.json Revert "temporarily disable critical linter functions" May 24, 2019
.gitattributes Release master (#586) May 7, 2019
.gitignore simplified version route Jul 23, 2019
.jshintrc travis Oct 19, 2016
.mergify.yml Initialize Mergify Sep 11, 2019
.npmignore travis Oct 19, 2016
.nvmrc use node 8.15 as in dockerfile May 27, 2019
.pullapprove.yml retrigger build Jun 19, 2019
.travis.yml Merge branch 'release/19.0.0' into develop Aug 7, 2019
Dockerfile against forgetting about version changes, note in Dockerfile May 28, 2019
LICENSE Force push Apr 28, 2017
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Aug 27, 2019
README.md Update codecov badge Jun 19, 2019
backup.sh [WIP] N21/merge (#452) Feb 11, 2019
codecov.yml Update badge color settings Jun 20, 2019
compose-server-test.dummy check mongo version Apr 15, 2019
crontab [WIP] N21/merge (#452) Feb 11, 2019
deploy.sh cancel deployment on docker build error Aug 6, 2019
localtime neue localtime (#507) Mar 13, 2019
migrate.js Fix connection string for production-like environments Jul 29, 2019
package-lock.json Merge tag '19.5.4' into develop Sep 18, 2019
package.json Merge tag '19.5.4' into develop Sep 18, 2019
startup.sh cronjob für rssfeeds zurück ins Dockerfile May 8, 2019
testdeploy neue localtime (#507) Mar 13, 2019
travis_rsa.enc [WIP] N21/merge (#452) Feb 11, 2019

README.md

Schul-Cloud Server

Based on Node.js and Feathers

Dev: Build Status Master: Build Status

Dev: codecov Master: codecov

Version Greenkeeper badge

Swagger UI documentation is available here. When running the server locally, it is served at http://localhost:3030/docs/.

Requirements

  • node.js
  • mongoDB

Setup

You will need the client as well. For more detailed setup instructions, take a look here. It is written for Windows but the procedure is similar for other OS.

Run

  1. Go into project folder
  2. run mongod
  3. run npm start
  4. run npm run setup

Debugger Configuration in Visual Studio Code

For more details how to set up Visual Studio Code, read this document.

How to name your branch and create a pull request (PR)

  1. Take the Ticket Number from JIRA (ticketsystem.schul-cloud.org), e.g. SC-999
  2. Name the feature branch beginning with Ticket Number, all words separated by dash "-", e.g. feature/SC-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. For more information check our Definition of Done here.

Testing

Run tests

  1. Go into project folder
  2. run npm run test

Create tests

  1. Create a folder for the "service" you're working on in "/test/services"
  2. Create a file "user.test.js" for frontend tests (e.g. clicking a link or check if url is available)
  3. Create a file "unit.test.js" for backend tests (e.g. calculating a number)

Try to cover as many methods as possible unit test wise - goal is 100% of course, so one test per method.

Commiting

Default branch: develop

  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/SC-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
You can’t perform that action at this time.