aureleoules / epitaf

📚 homework manager for EPITA

EPITAF

Virtual agenda for EPITA.

Contributing

Here is the process to install EPITAF's development environment.

1. Start the database & backend

$ cp .env.sample .env 
$ docker-compose up -d
$ go build
$ ./epitaf init
$ ./epitaf start

2. Add a user

$ docker exec -it epitafdb echo 'INSERT INTO users (login, name, email, promotion, semester, region, class) values ("your.login", "Your Name", "[email protected]", 2024, "S5", "Paris", "A2")' | mysql -uroot -proot -h127.0.0.1 epitaf

3. Setup UI

$ cd ui
$ echo 'REACT_APP_API_ENDPOINT=http://localhost:8080/v1' > .env
$ yarn
$ yarn start

4. Login

$ ./epitaf login [email protected]
> click the link

Checkout localhost:3000.

epitaf's Issues

[Enhancement] Create valid favicons for phones. Make it look like a native "app"

Not really an issue but could be cool if the favicons were generated for ALL devices.
For exemple on iPhone you could "extract" the website to make it look like a native app on the IOS home menu using safari.
Sadly the icon for the app looks like shit since you DID NOT generated/set one.
Instead of creating every icons by hand there is a bunch of websites who do it for you. For exemple https://realfavicongenerator.net/ it create it for windows metro, IOS, android, macOS, etc...

Add filters / custom views for task

Allow user to add filter on the tasks view.

Ex: Get only Done tasks, To do, Late etc....

A system to save this custom view (link with the account) would be awesome

Lock task from being edited

The author of a task should be able to lock modifications so others can't edit.
Could be useful for teachers.

Insecure dependencies: CVE-2020-28483, CVE-2020-29652, CVE-2021-43565, CVE-2022-27191

CVE-2020-28483

[Component] github.com/gin-gonic/gin
[Vector] A malicious user can spoof their source IP address by setting the X-Forwarded-For header
[Severity] 7.1 High
[CWR] HTTP Request/Response Smuggling

Implicated code:

epitaf/api/api.go

Line 57 in 8d7c3bf

if err := r.Run(); err != nil {

Additionally vulnerabilities in indirect packages

[Impact] LOW

These packages are not directly used in Epitaf but are by its dependencies. I do not believe these vulnerabilities are exploitable in Epitaf, but it is still recommended to upgrade them regardless.

golang.org/x/crypto/ssh

• CVE-2020-29652
• CVE-2021-43565
• CVE-2022-27191

References

• https://pkg.go.dev/vuln/GO-2021-0052
• https://nvd.nist.gov/vuln/detail/CVE-2020-28483
• https://pkg.go.dev/vuln/GO-2021-0356
• https://nvd.nist.gov/vuln/detail/CVE-2022-27191
• https://pkg.go.dev/vuln/GO-2022-0968
• https://nvd.nist.gov/vuln/detail/CVE-2021-43565
• https://pkg.go.dev/vuln/GO-2021-0227
• https://nvd.nist.gov/vuln/detail/CVE-2020-29652

Fix calendar for teachers

Fix some calendar entries not showing up

bug related with Chronos sub-groups

Add markdown label

Add a label indicating the format of a task content.

Classe/Semestres inversés dans l'onglet profil

Be able to add files for each topic (pdf)

For example a new menu with the list of topics and downloadable pdfs.

Assignation de Semestre/Classe/Région avec assistant (ex: YAKA)

Petit bug avec les infos du profil affichées pour les assistants, soit cela vient de l'API avec la BDD du cri, soit d'une feature non finie ou testée ?

Mark task as done

Add a button to individually mark a task as done or completed.

Start date for assigments

Actually assignments can only have a due date.
In order to depopulate assignments lists with currently unavailable items, it would be a great idea to add a start date

UI/UX discussion

I want to open a discussion about the design.
Isn't easier to read if the title of the Homework is the Big title of the element and the course's name in bottom ?

Here is an modified example :

What are you guys thinking ?

Add tasks due for a given time range

Instead of a fixed due date, choose two dates. The task should be shown in a different view or different color?

Create schedules with only a few students.

No days on schedule

It should be great to have the day next to the date.

Example:
25 October => Monday 25 October

Save custom groups of students

I would like to create a group a student and be able to share homeworks with them without having to add them manually each time

General "mark as done" task

Add the possibility to mark as done a task for every user who have acess to the task. It also could be for peaple inside a group to see who have finished a task
Utility : For group projet, it could helps to manage task / For a class or promo, student how strugle with an homework could easly know who should be able to help them.