Skip to content

A free, open-source web application that generates UML diagrams based on PocketBase databases

License

Notifications You must be signed in to change notification settings

pocketbase-uml/pocketbase-uml.github.io

Repository files navigation

PocketBaseUML

License NPM version Last commit Downloads Language Sponsor the author
Publish NPM & deploy docs workflow

A free, open-source web application that generates UML diagrams from PocketBase databases.

PocketBaseUML

How to use

PocketBaseUML is a web application that runs in your browser.
You can access it online at pocketbase-uml.github.io or run it locally on your computer with:

npx pocketbase-uml@latest

Due to security browser restrictions, the online application can only access PocketBase databases through HTTPS.
If you want to access a local PocketBase databases through HTTP, you can either run the application locally or use a service such as ngrok to expose your local server to the Internet.

Sponsor the project

If you find this package useful, please consider ❤️ sponsoring my work. Your sponsorship will help me dedicate more time to maintaining the project and will encourage me to add new features and fix existing bugs.

Other means of support

If you find this package useful, please 🙏 star the repository, 💕 tweet about it, 👍 endorse me on LinkedIn or consider hiring my services.

The more stars this repository gets, the more visibility it gains among the PocketBase users community. The more users it gets, the more chances that some of those users will become active code contributors willing to put their effort into bringing new features to life and/or fixing bugs.

As the repository gain awareness, my chances of getting sponsored will increase, which in turn will help maintain my vested interest in keeping the project alive.

Hiring the author

If you want to hire my services, don’t hesitate to drop me a line at the email address listed in my GitHub profile. I’m currently getting a constant flow of approaches, some of them relevant, others not so relevant. Mentioning “PocketBaseUML” in your text would help me prioritize your message.

License

The MIT License.