/sdk4ed-td

Technical Debt Management ToolBox developed for SDK4ED (https://sdk4ed.eu) from University of Macedonia (UoM). It provides TD principal, TD interest, TD breaking point, Refactoring opportunities, prediction of high TD classes.

Primary LanguageJavaScriptMIT LicenseMIT

SDK4ED Dashboard

Welcome to the SDK4ED Dashboard repository. The dashboard is currently based on a free online template available at https://mdbootstrap.com.

The dashboard relies on React for building dynamic web pages with shareable elements among different pages.

Charts and plots will be visualized with HighCharts which provides support for React and a series of other programming languages, including Python and R.

Documentation for these frameworks can be found directly on their site. The components defined in the project are documented through JSDoc.

All of these libraries are provided under MIT License and thus free to use in the SDK4ED project.

Repository organization

Directories and files:

  • . contains the license, the README, and some project-level configuration files used by NodeJS.
  • node_modules after installing them through nvm, it will contain the modules needed to deploy the application.
  • src Contains the source code of the dashboard organized as follows:
    • . The root contains the main application files.
    • components contains the React components and pages of the dashboard.
    • assets contains artefacts like icons and images that are used within the components.
  • public contains the files that are actually visible to everyone with access on the server.

SDK4ED APIs

See here for the API design.

Installation instruction (For developers)

  • To deploy the application you have to first install all the dependencies used.
npm install

  • Next, you must create a .env file in the root directory of the application. Copy the contents of the .env-default file (also found in root directory) inside the .env file. The .env file contains all environment variables that hold host configurations for each toolbox, so you should modify environment variables accordingly. Remember to restart the application each time you modify this file.

  • Finally, you can start the server and a web page should open on your favorite browser.

npm start

To fully be able to test the application you will need to run the dummy data server:

nodejs ./src/DummyDataServer.js

Now you can navigate to the SDK4ED dashboard.

In case you are on Linux and you have issue with seeing the updates you make in your webpage, the run

./file-limit.sh

from the main project directory.

Docker Compose build

docker-compose -f ./docker-compose.yml -p sdk4ed up --always-recreate-deps --force-recreate --build