Skip to content

Commit

Permalink
docs: write most of the status.md page content with crunch, demo, bac…
Browse files Browse the repository at this point in the history
…helor work
  • Loading branch information
samuelroland committed Jan 18, 2025
1 parent ee4e2c9 commit ce822df
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/src/status.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# Project status

These are a few notes about the project status. Everything has been done during PDG (Projet De Groupe) during 3 weeks with a team of 4 IT students. As the landing page doesn't include screenshots and project progression details, I thought having a dedicated page could be useful !

## Demo
Here are few screenshots of the current UIs built into PLX, it is currently possible to do C and C++ exos (without any compilation dependency) with output checks only.

The home page
![demo of the home page with ASCII art in gradient red to orange](./img/png/demo-home.png)

The list page with list of skills and exos (fictive course for development purpose)
![list of skills at left, list of exos at right, current exo selected at right in blue](./img/png/demo-list.png)

Showing compilation errors with a few manipulations of the output (absolute path like `/home/sam/...../project/exos/main.c` have been replaced with just `main.c`)
![simple compilation error in C with a missing ending semi-colon](./img/png/demo-compilation.png)

Simple output checks to verify basic cases and 2 error cases, with a trivial C program. This is a simple display of an important feature: smart diffing, the possibility to highlight specific words that are changed on a given line and not just indicate red+green lines like Git does.
![1 check is not passing among 3 checks, there is a missing space between 2 words, the mix is highlighted to quickly identify what is different](./img/png/demo-checks.png)

## Bachelor work
Samuel Roland is going to work on the following big features during ~450 hours during the last semester at HEIG-VD for his bachelor work. This is an amazing opportunity to continue the project with dedicated time !

1. Supporting the [DY syntax](https://delibay.org/docs/use/dy-syntax) (invented for Delibay) in PLX to have a common light and human readable+writable (a.k.a delightful) syntax to define and maintain exos
1. Allowing teachers to see the code and results of students during a live sessions in class, the code is sent to a central server and sent back to the teacher's PLX so there is an opportunity to see the progress, to give global feedback, create interactions around the various approaches...

## Crunch startupper challenge
Samuel is going to participate to the Crunch startupper challenge, the team is still in research. This will allow the project to search and define a potential business model to see if it could be financially sustainable in the long run.

Here the 2 main ideas of business model, around PLX
1. Annual subscriptions for instituations (schools, universities, ...) including
1. Integrating PLX into existing courses
1. Coaching teachers to have a deliberate approach to teaching instead of the lecture based approach
1. Creating exos or transcribe existing ones to PLX formats
1. Supporting new programming languages or exos types
1. Montly subscriptions for passionnated people
1. Trainings based on PLX (mix of classic content like video, demos, audio and a lot of exos in PLX directly)
1. Personal coaching with these people for personal projects they might have, to give the human feedback and continue to improve course content to match the needs.

These ideas are not mature and must be tested/validated with user interviews and other researches... This is why **I'm searching for 2 persons at HEIG-VD doing the Crunch this year to join my team: ideally one person in HEG and another in COMEM :)** If you are interested, please contact me !

## History
1. First development during PDG (Projet De Groupe) during 3 weeks with a team of 4 IT students. TODO: more details.

0 comments on commit ce822df

Please sign in to comment.