Workshop Scheduler

GitHub Repository

https://github.com/NewcastleRSE/WorkshopScheduler_Java

About

When organising a Carpentries workshop a website is created for the workshop using the Carpentries workshop template (https://github.com/carpentries/workshop-template). The workshop template includes a schedule which shows the start and end times of each episode for every day including break times. This program allows a user to capture the start time of a session and the length (in minutes) of all the episodes. The program also allows break and lunch times to be inserted at any point. The program provides for initial keybard input or input from a csv file. Once the user is happy with the schedule it can be exported as an html table which can then be included in the workshop website repository saved as a file called schedule.html.

Click for USER MANUAL

Project Team

• Dr Jannetta Steyn, [email protected]
• Ruxandra Neatu

RSE Contact

Jannetta Steyn RSE Team
Newcastle University
([email protected])

Built With

• Java 17
• SparkJava
• Apache Log4J
• Apache Maven
• Gson
• Junit
• MigLayout

Getting Started

Links with tutorials

• YouTube MigLayout tutorial
• Maven Repository

Prerequisites

Java 17

Installation

mvn package

Running Locally

java -cp <path-to>jws.jar Main

Running Tests

How to run tests on your local system.

Deployment

Create a directory for the binary and change into it, eg.

mkdir WorkshopAdmin
cd WorkshopAdmin

Suggested

Create a directory for keeping schedule files. Make sure you are in the WorkshopAdmin directory that you created in the previous step.

mkdir schedules
cd schedules

Create your schedules in this directory. There are some example schedules in the repository that can be used and are based on The Carpentries default lessons.

License

Citiation

Please cite the associated papers for this work if you use this code:

@article{xxx2021paper,
  title={Title},
  author={Author},
  journal={arXiv},
  year={2021}
}