Skip to content

The control-PWA of the centralized network of the project "Freshloop" for the German competition "Jugend Forscht".

Notifications You must be signed in to change notification settings

flogoetzrath/freshloop-controlunit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Freshloop-Controlunit

The hub-part of the freshloop-network.

Getting Started

These instructions will get you the latest version of this project up and running on your local mashine for testing and development purposes. See installation on how to deploy it on a live system.

Please note, that this application is intended to run in a linux environment. Thereby it is recommended to set up a virtual machine for that purpose.

Prerequesites

  • PHP - A recent version of PHP, preferably PHP 7.2 or higher
  • Apache Server - A local Server. Recommended: Express Installation of Xampp -> Apache Server.
  • MySQL Instance - Comes with the Xampp installation

Installation

A short guidance on how to set the project up on you local mashine.

After forfilling the prerequesites mentioned above, the project can be cloned with the following command from your git bash:

git clone https://github.com/F9lke/freshloop-controlunit

Since there is no auto-installation functionality, it is essential to manually create the table structures. Please copy and paste the code found in the advised file into your mysql bash or phpmyadmin sql code line.

root > lib > sql > freshloop.sql

In interests of not committing all libraries, additional ones, that are positioned in the following location, are part of the project. They have to be downloaded and inserted to their intended destination. See built with for a list of the dependencies needed.

root > lib > ui > *

Built With

Form: [Name+Link] - [Description] - [Name of Directory in Project]

  • Bootstrap - The main web framework used for frontend purposes - bootstrap
  • Bulma - The fallback web framework used for frontend purposes - bulma
  • ChartJS - A comprehensive and visually stunning chart library - chartjs
  • DriverJS - An interactive tutorial library - driverjs
  • Fontawesome - The icon supplied used - fontawesome
  • jQuery - The main JavaScript framework used - jquery
  • Popper - The tooltip positioning engine used - popper
  • Slick - An intuitive carousel library - slick
  • Timepicker - A jQuery plugin to generate timepicker-ui components - timepicker
  • Toastr - A basic tooltip library - toastr

Furthermore a code fragment of a plugin is used, that can't be retraced at this point. The fragment is contained in the directory "moveit" under root > lib. In order for the application to work in its full glory, the "moveit" directory has to be moved inside the "ui" folder.

About

The control-PWA of the centralized network of the project "Freshloop" for the German competition "Jugend Forscht".

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published