schedule-psi

schedule-psi is a software designed to help the Junior-Entreprise Physique Strasbourg Ingenierie (PSI) to schedule the meetings to interview their members. The software has been especially designed for their needs. Only a French version is supported for now.

Description

The software is built in Kotlin with the TornadoFX framework. Maeven was used to compile the project.

The software use the information from the Excel file exported by the Doodle tool. Only the tool french version is handled. Members must specify their availabilities on the website and then the corresponding Excel file is used by the software to start planning.

The software stores JSON file as historics. The corresponding folder is called MyPlannings.

Get started

User mode

Download the zip file schedule-psi-x.x.x-release.zip within the releases. This archive gathers all elements needed to execute the software. Unzip the archive and open the exe file within it. The exe was produced with two steps:

• Computing the JAR file of the project from my IDE (IntelliJ IDEA 2020 - Artifacts)
• Converting JAR file into EXE file thanks to Launch4J

NOTE: The historic folder will be written in the home repository.

Developer mode

For any contribution or modification:

• Set up the proper environment to run any Kotlin project: Java JDK + IDE. See Getting Started with Kotlin tutorial.
• Install JavaFX in your environment with Gradle, Maven or manually.
• Install the TornadoFX framework.
• Clone or fork this repository:

   git clone https://github.com/lcaruso27/schedule-psi.git
  
   git fork https://github.com/lcaruso27/schedule-psi.git
  

• Open schedule-psi project from your favorite IDE. Feel free to use either Maven or Gradle as compiler for the project.

NOTE: The historic folder will be written at the root of the project directory.

Repository organisation

schedule-psi
├── src 						- Source code of the whole project
├── .gitignore						- Specifies folder and files not to add in Git
├── LICENSE						- Project license
├── README.md						- Readme file
├── TUTORIAL.md						- Quick tutorial about the software
└── pom.xml 						- XML file to compile the project with Maeven

Screenshots

License

schedule-psi is available under the MIT license. See LICENSE file.

Additional information

Any thoughtful and helpful comments are welcome to improve the software. :)