Server API docs

[VewDev]

Are there any docs explaining the server API endpoints or with a list of available endpoints? Even if it is some swagger generated file.

If not, will try my best to generate some documentation via Wireshark/code inspection.

[OskarKarpinski]

I didn't do documentation, you can analyze how the server or API client works in typescript for example.

[OskarKarpinski]

As for LibrePass-Browser are you able to write this in svelte with tailwindcss? Because the site is in svelte with tailwindcss and it's probably better if it's in the same frameworks.

[VewDev]

Oh yeah sure. I went for React as it is usually my go-to framework for web dev, but using the same framework is indeed a better option.

[VewDev]

@M3DZIK I have been working on an API documentation (currently just an explanatory LibreOffice doc). Which format should we make the official documentation on? Maybe Markdown for GitHub Wiki? I have also considered making DRAWIO diagrams explaining code flows.

[OskarKarpinski]

Markdown will be good, drawio diagrams sounds good

[VewDev]

@M3DZIK I have finished writing the API documentation (https://github.com/je-sendra/LibrePass-Docs) for the current controllers.

Please review it and give me feedback. If you are okay with it, we could try moving the repository to the LibrePass org.

PS: Sorry my contributions are slow, I have a lot of work to do rn.

[OskarKarpinski]

Thanks!

[VewDev]

It's no problem. I will start working on the LibrePass-Browser extension this week. Should we create a "LibrePass Development" project for better management?

Also, please contact me via the email in my profile and I will give you my contact info, so we can chat easily.

Btw, I have just seen there was already a "LibrePass-Docs" repo in the org. I think we should rename it to "LibrePass-Manual" or "LibrePass-UserManual" since it seems more oriented towards a end-user audience rather than technical documentation.

Keep up the good work! 🏆

[VewDev]

The official technical documentation for LibrePass API, among others, can be found here.

https://github.com/LibrePass/LibrePass-Docs