dino-kupinic / schulbuchaktion Goto Github PK

Describe the Feature
Add Inter font family

Is your feature request related to a problem? Please describe.
Add typescript for proper type checks

Describe the solution you'd like
pnpm install typescript and configure tsconfig.json in root dir

Describe the Feature
Create a toggle button to switch between light and dark

Design in Figma

Describe the Feature

write getting started section in english and german

Describe the bug
composer.json in the root directory

Expected behavior
php unit in /backend

Describe the Feature

Install the following:

• DevTools
• Pinia
• Tailwind
• i18n
• VueUse
• Color Mode
• test-utils
• icon
• pinia-plugin-persistedstate
• nuxtUI
• csurf (?)
• nuxt security (?)
• storybook
• vite-pwa-nuxt
• typed-router (?)
• auto-animate (?)
• nuxt-viewport

Modules marked with (?) should be discussed.

Is your feature request related to a problem? Please describe.
add loading template while javascript renders

Describe the Feature

display a table of order books associated with the user

Describe the Feature
XLSX files should be parsed in the backend.
The XLSX file should be input in the frontend and send the file to an backend endpoint.

I think we should call the endpoint api/v1/importXLSX

https://phpspreadsheet.readthedocs.io/en/latest/

Is your feature request related to a problem? Please describe.
add smoke tests to validate symfony can properly initialize etc

https://en.wikipedia.org/wiki/Smoke_testing_(software)

Is your feature request related to a problem? Please describe.
General improvements and new features

Describe the solution you'd like
nuxi upgrade --force

Describe this Feature

Task can be found here:
https://www.htl-steyr.ac.at/intern/wiki/doku.php?id=el-it:itp2:umsetzung_it_projekte:exercises:schulbuchaktion

Describe the Feature

display the list of all teachers
clicking on a teacher should display

• the table of their books
• last login

Describe the Feature
Create a service for each Entity for which we need CRUD operations

Make sure to test the services thoroughly.

Is your feature request related to a problem? Please describe.
the navbar is (somewhat) functional but needs polish

Describe the Feature

make it possible to authenticate against an LDAP server

Describe the Feature

The login page should be created on the /login route
This issue is only for creating the form, not functionality

Describe the Feature
this issue depends on #80

After successful parsing, insert the data into the respective tables.

https://phpspreadsheet.readthedocs.io/en/latest/

Describe the Feature
Add a settings page

Design in Figma

Describe the Feature

add automatic testing for endpoints

Describe the Feature
Add dependabot to automatically upgrade dependencies

Is your feature request related to a problem? Please describe.
automatic formatting and quality checks

Describe the Feature

add workflows in .github that should pass on every pullrequest

Describe the Feature

In order to test our app we need Unit-Testing and E2E-Testing

Is your feature request related to a problem? Please describe.
Due to inactivity of storybook module we should just remove it for now

Describe the Feature

add a table for viewing the ordered books

Design in figma

Describe the Feature
add a table for viewing the books imported from the .xlsx-file.

Design in figma

Describe this Feature

In order to easily setup our documentation, we should setup this:
https://docus.dev/

Describe the Feature

Delete the pre configured things we don't need.

• Create a introduction page.
• Create a "User" Section
• Create a "Technical" Section
• Make it possible to switch between german and english.
• Setup easy creation of either german or english docu markdown pages
• add search functionality if possible (?)

Describe the bug

Build error

To Reproduce
pnpm run build-docs

Expected behavior
It should build with no problems

Screenshots

Describe the Feature
configure i18n with en-US.json and de-DE.json

Describe the Feature

Add a usable LLM to Schulbuchaktion:

• perhaps Llama 3 with 8B Parameters (No Vercel AI SDK)
• Mistral AI (Vercel AI SDK)

Could be used to get Book recommendations or ask questions
We would need to customize the model and feed it the XLSX data

Is your feature request related to a problem? Please describe.
We should test our endpoints to quickly tell if everything works

Describe the Feature

Create controllers for accessing data.
Check if user has rights to the resources will be done with a middle which IS NOT part of this issue.
Look at https://github.com/HTL-Steyr/Schulbuchaktion/tree/master/Backend/app/src/Controller for some inspiration.

Can we generate api documentation with OpenAPI?

Describe the Feature
We can re-use it from UntisPlanner, though small changes are needed

Design in Figma

Describe the Feature

Get the specific groups out of LDAP service.

Describe the Feature
Create a button for switching between languages

locales should be defined in /locales, e.g. /en-US.json

Design in Figma

Describe the Feature

check with bearer/jwt token

Is your feature request related to a problem? Please describe.
Autocomplete does not work properly in PHPStorm

Describe the solution you'd like
install tailwind and configure postcss

Describe the Feature

For testing our routes we should use PHPUnit
https://symfony.com/doc/current/testing.html

Add an example test (perhaps with a template) to see if it works.

Is your feature request related to a problem? Please describe.
Setup is outdated and needs more steps

Is your feature request related to a problem? Please describe.
In the README it is not mentioned that docker needs to be started.
Also docs setup is not found.

Describe the solution you'd like
Add docker compose steps
Add vitepress setup steps

Describe the Feature
Create the avatar icon with a dropdown

• Profile Link
• My Books Link
• All Teachers Link

The links can point to nothing for this issue

Design in Figma

Describe the Feature

clicking the three dots and on edit should open up a modal to edit the book.

https://ui.nuxt.com/components/modal

Describe the Feature

add entity models based on the er-diagram.
You can use the make:entity command

Describe the Feature

create a design which then can be worked on by the frontend team

Describe the Feature

create a confirmation modal on deleting a book order

Are you sure you want to delete "<book order>"?
Delete Cancel

delete button should be red

https://ui.nuxt.com/components/modal

Describe the Feature

Make request against backend
If it fails, display a error to the user with detailed information of what went wrong

store JWT in Cookie with useCookie() composable

protect routes when the user is not authenticated (trying to access /import for example should redirect to login)

Describe the Feature

We need a navbar to provide easy navigation between the pages.
Look into Figma for the design

For responsive design we could use nuxt-viewport perhaps

create the components in components/nav:

• main component should be NavBar.vue
• break up the elements into smaller parts (e.g. NavItem, ...)

This issue depends on following other issues:

• #30
• #32
• #33
• #34

placeholders can be used while the other issues are not done