Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.61 KB

dependencies.md

File metadata and controls

41 lines (25 loc) · 1.61 KB
Raw

Managing Server-Side Dependencies

TEAMMATES uses Gradle to manage dependencies to external Java libraries.

Adding new libraries

There are two factors to consider:

  • Whether the library is for production or non-production code
  • Whether the library is needed for compile-time or runtime only

Add the library based on the name listed in Maven Central in the appropriate section in the build.gradle file.

Updating libraries

Note the following:

  • Change ./gradlew to gradlew.bat in Windows.
  • All the commands are assumed to be run from the root project folder, unless otherwise specified.

To update a library's version, simply change the version number declared in build.gradle file.

If you are using Eclipse, you need to do a manual update to your Eclipse configuration to reflect the above changes. You will do so by running the following command:

./gradlew resetEclipseDeps

Sometimes, the changes from this command might not show up in Eclipse immediately. "Refreshing" the project or restarting Eclipse should fix that.

Managing Client-Side Dependencies

We use NPM registry as the source of library codes.

To add/update libraries for CSS/JS, modify the appropriate entry in src/main/resources/package.json. Additionally, when adding new libraries, find the files from the library that are necessary to be loaded to webpages, and add a new entry(ies) in FrontEndLibrary.java.

If the library cannot be found in NPM, simply host a local copy in the repository.