This is the source code that powers Franken UI website. Use this repository to have an offline version of the documentation. If you find errors, you can report an issue or propose changes via pull-requests.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Correct environment variables must be set. Go ahead and create .env file from the root directory.
| Key | Value |
|---|---|
FRAMES_URL |
https://frames.franken-ui.dev |
TAG |
internal |
Franken UI is an independent, MIT-licensed open source project with its ongoing development made possible entirely by the support of the community. If Franken UI has been beneficial to you in any way, please consider contributing by making a donation, which will help maintain and improve it for the benefit of everyone.
Thanks to the following:
And the amazing individuals from Ko-Fi who helped it since day one.
Licensed under the MIT license.
