writer / writer-framework

No-code in the front, Python in the back. An open-source framework for creating data apps.
https://dev.writer.com/framework/introduction
Apache License 2.0
1.3k stars 73 forks source link

exclude generated files as storybook and app_templates from repository #385

Closed FabienArcellier closed 3 weeks ago

FabienArcellier commented 5 months ago

Generated files like stories or application templates should be ignored by git. They will be rebuilt in commands that take advantage of them like alfred build.

.gitignore

src/streamsync/app_templates/*
src/streamsync/ui.py
src/ui/components.codegen.json
src/ui/src/stories/**

build consistent pypi package : alfred build

alfred build must provision the default and hello applications, as well as regenerate the ui.py file. The goal is to have a complete package before sending it to pypi.

install dev environment : alfred install.dev

alfred install.dev command installs the build poetry dependencies and generates the various files locally which are necessary during development such as the ui.py file, the stories

run storybook : alfred npm.storybook

alfred npm.storybook updates story files before launching storybook.