status-desktop/storybook
Noelia 7aaf8fcec2 feat(MintToken/RemoteDestruct): Review and update remote self destruct flow
Updated strings and renamed files.

Part of #10603
2023-05-18 15:28:44 +02:00
..
pages feat(MintToken/RemoteDestruct): Review and update remote self destruct flow 2023-05-18 15:28:44 +02:00
qmlTests fix(StatusQ): StatusQ is QML module (#10207) 2023-04-14 11:18:56 +03:00
src feat(MintTokens): Update `CommunityCollectibleView` according to new design 2023-05-16 13:07:56 +02:00
stubs chore(Storybook): Basic pages for SendModal and TokenListView added 2023-05-12 20:14:02 +02:00
tests feat(Storybook): Possibility to modify Figma links directly from the app 2022-11-29 22:28:57 +01:00
CMakeLists.txt fix(Wallet) network selection and unify network implementations 2023-04-20 19:34:24 +02:00
PagesModel.qml feat(MintToken/RemoteDestruct): Review and update remote self destruct flow 2023-05-18 15:28:44 +02:00
README.md chore(Storybook): Update Readme to point CMakeLists.txt as the main way to build instead of WebAssembly 2023-03-01 13:48:31 +01:00
StoryBook.pro move qzxing and SortFilterProxyModel to vendor folder 2023-03-23 12:09:19 +01:00
cachecleaner.cpp feat(Storybook): Hot reloading for pages 2022-10-20 20:34:35 +02:00
cachecleaner.h feat(Storybook): Hot reloading for pages 2022-10-20 20:34:35 +02:00
directorieswatcher.cpp chore(Storybook): add pages for InviteFriendsToCommunityPopup and related components 2022-10-25 17:03:44 +02:00
directorieswatcher.h feat(Storybook): Hot reloading for pages 2022-10-20 20:34:35 +02:00
figma.json feat(CommunityNewAirdropView): design-compliant token airdrop flow for collectibles 2023-05-08 11:44:10 +02:00
figmadecoratormodel.cpp feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
figmadecoratormodel.h fix(storybook): add missing <optional> include 2022-12-05 13:47:40 +01:00
figmaio.cpp feat(Storybook): Possibility to modify Figma links directly from the app 2022-11-29 22:28:57 +01:00
figmaio.h feat(Storybook): Possibility to modify Figma links directly from the app 2022-11-29 22:28:57 +01:00
figmalinks.cpp feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
figmalinks.h feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
figmalinksmodel.cpp feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
figmalinksmodel.h feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
figmalinkssource.cpp feat(Storybook): Possibility to modify Figma links directly from the app 2022-11-29 22:28:57 +01:00
figmalinkssource.h feat(Storybook): Possibility to modify Figma links directly from the app 2022-11-29 22:28:57 +01:00
main.cpp fix(StatusQ): StatusQ is QML module (#10207) 2023-04-14 11:18:56 +03:00
main.qml Storybook: Inspection tool - support for popups added 2023-05-10 12:50:52 +02:00
modelutils.cpp feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
modelutils.h feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
sectionsdecoratormodel.cpp feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00
sectionsdecoratormodel.h feat(Storybook): Figma links loaded from json file 2022-11-29 11:30:13 +01:00

README.md

Building Storybook

For regular usage of Storybook it's enough to open status-desktop/storybook/CMakeLists.txt in QtCreator. Please do not use StoryBook.pro which is intended for WebAssembly builds. Please make sure that selected run target is Storybook.

Building Storybook with Webassembly and Qt 5.14

Configuring the environment

Install Emscripten v1.38.27

# Get the emsdk repo
git clone https://github.com/emscripten-core/emsdk.git

#go to emsdk folder
cd emsdk

#install Emscripten v1.38.27
./emsdk install emscripten-1.38.27

#activate emscripten-1.38.27
./emsdk activate emscripten-1.38.27

#install Fastcomp backend
./emsdk install fastcomp-clang-tag-e1.38.27-64bit

#activate Fastcomp backend
./emsdk activate fastcomp-clang-tag-e1.38.27-64bit

#add emsdk tools to env variables
#this can be done by following instructions received from previous activate command
#there are two options:

#1. Configure the env variables for the current shell only:
source emsdk_env.sh

#2. Configure the env variables using the shell startup script:
echo 'source "[path to emsdk folder]/emsdk_env.sh"' >> $HOME/.zprofile

#WARNING: this will configure the environment to use the emsdk compiler
#Ex:"which clang" command will now point to the emscripten clang instead of the system clang
#to disable the env configuration comment the source command added earlier in ~/.zprofile

#check environment
#python needs to be installed. The emsdk scripts state that it should work with pyton 2 and 3
#make sure python command can be resolved
which python
em++ --version
emcc --version
#clang should point to fastcomp-clang-tag-e1.38.27-64bit
which clang
which clang++

More documentation: https://emscripten.org/docs/getting_started/downloads.html

Configure QtCreator (optional)

Newer versions of QtCreator won't support Qt5.14 with Webassembly. Latest version found to support Qt5.14 with WebAssembly is 4.14.2 Download: https://download.qt.io/archive/qtcreator/4.14/

Adding the Emscripten compilers (emcc and em++) Details here: https://doc.qt.io/qtcreator/creator-tool-chains.html

Adding Qt version 5.14: https://doc.qt.io/qtcreator/creator-project-qmake.html

Adding Qt5.14 for Webassembly kit: https://doc.qt.io/qtcreator/creator-targets.html

Open StoryBook.pro in Qt Creator and configure it using the new kit.

Qt creator might not set the env paths correctly. In this case manually set build environment variables (Projects -> 5.14.2 kit -> Build -> Build Environment -> Batch edit). Ex:

EMSCRIPTEN=~/Repos/emsdk/emscripten/1.38.27
EMSDK=~/Repos/emsdk
EMSDK_NODE=~/Repos/emsdk/node/14.18.2_64bit/bin/node
EMSDK_PYTHON=~/Repos/emsdk/python/3.9.2_64bit/bin/python3
EM_CONFIG=~/Repos/emsdk/.emscripten
LLVM_ROOT=~/Repos/emsdk/fastcomp-clang/tag-e1.38.27/build_tag-e1.38.27_64/bin
PATH=[check echo $PATH]

Running qmake (without qt Creator)

#create build folder
mkdir buildStoryBook

#go to folder
cd buildStoryBook

#run qmake (add CONFIG+=debug CONFIG+=qml_debug to qmake command for debug build)
~/Qt/5.14.2/wasm_32/bin/qmake [path to StoryBook.pro] -spec wasm-emscripten && /usr/bin/make qmake_all

#build (add -j[nb of cores] for parallel execution)
make

#run
emrun StoryBook.html