From c465585389191d44d11d98e817049474aaed0622 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Kruszyna?= Date: Mon, 19 Feb 2024 14:44:25 +0100 Subject: [PATCH 1/3] quick start guide --- .gitignore | 4 ++++ README.md | 18 ++++++++++++++++++ package.json | 5 ++++- 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/.gitignore b/.gitignore index 26221a2..1270203 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,8 @@ deps/codemirror/mode/* !deps/codemirror/mode/meta.js !deps/codemirror/mode/javascript +node_modules/ + +package-lock.json + *~ diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a36b66 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +QUICK START + +Prepare qmlweb repository: + +1. git clone --recurse-submodules https://github.com/qmlweb/qmlweb.git +2. cd qmlweb (go to qmlweb dir) +3. npm install (install qmlweb dependencies) +4. npm link (link qmlweb repository as local npm library) + +Prepare qmlweb.github.io repository: + +5. cd .. (leave qmlweb repository) +6. git clone --recurse-submodules https://github.com/qmlweb/qmlweb.github.io.git (clone qmlweb webpage repository) +7. npm link qmlweb +8. npm install (install dependencies) +9. npm install vite (install web server) +10. npx vite (this run webserwer, open browser and go to http://localhost:5173/ , qmlweb.github.io page shoud appear) + \ No newline at end of file diff --git a/package.json b/package.json index 38f4991..7eeda86 100644 --- a/package.json +++ b/package.json @@ -15,5 +15,8 @@ "bugs": { "url": "https://github.com/qmlweb/qmlweb.github.io/issues" }, - "homepage": "https://github.com/qmlweb/qmlweb.github.io#readme" + "homepage": "https://github.com/qmlweb/qmlweb.github.io#readme", + "devDependencies": { + "vite": "^5.1.3" + } } From 0461857c3724ff2bc769a988fe9e81854763f540 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Kruszyna?= Date: Mon, 19 Feb 2024 14:46:07 +0100 Subject: [PATCH 2/3] fix README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a36b66..f7493dd 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,5 @@ Prepare qmlweb.github.io repository: 6. git clone --recurse-submodules https://github.com/qmlweb/qmlweb.github.io.git (clone qmlweb webpage repository) 7. npm link qmlweb 8. npm install (install dependencies) -9. npm install vite (install web server) -10. npx vite (this run webserwer, open browser and go to http://localhost:5173/ , qmlweb.github.io page shoud appear) +9. npx vite (this run webserwer, open browser and go to http://localhost:5173/ , qmlweb.github.io page shoud appear) \ No newline at end of file From aa74cc8d935e4e9f67f9a90428d197e68b6fb79a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Kruszyna?= Date: Mon, 19 Feb 2024 15:12:27 +0100 Subject: [PATCH 3/3] add build step into README.md --- .gitignore | 3 +++ README.md | 1 + 2 files changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 1270203..313b39c 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,9 @@ deps/codemirror/mode/* !deps/codemirror/mode/meta.js !deps/codemirror/mode/javascript +#npx vite build +dist/ + node_modules/ package-lock.json diff --git a/README.md b/README.md index f7493dd..1e22a7e 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,5 @@ Prepare qmlweb.github.io repository: 7. npm link qmlweb 8. npm install (install dependencies) 9. npx vite (this run webserwer, open browser and go to http://localhost:5173/ , qmlweb.github.io page shoud appear) +10. npx vite build (build page, page will be build in ./dist folder) \ No newline at end of file