Skip to content

Update Readme and package.json #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hobbsythe6th wants to merge 3 commits into
base: development
Choose a base branch
from
Open

Update Readme and package.json #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31ac6df
Update readme for Windows users
hobbsythe6th May 1, 2026
0700a54
Update package.json
hobbsythe6th May 1, 2026
8669920
Merge branch 'development' of https://github.com/hobbsythe6th/Candles…
hobbsythe6th May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Candlestick is a fork of Wick Editor, a free and open-source tool for creating g
We plan to update our Node packages in the future. Until then, you will need to use Node Version 14 to install the right packages. If using an M-series Mac, this will require installing Rosetta 2.

See the original Wick Editor [README](https://github.com/Wicklets/wick-editor/blob/master/README.md) for older instructions.
Newer instructions are provided below, with a focus on Mac development.
Newer instructions are provided below, with a focus on Mac development. If you're a Windows user, look at [StickmanRed](https://github.com/StickmanRed)'s guide [here](https://github.com/StickmanRed/wick-editor/discussions/40). You should still read these instructions first, though.

### 1. Homebrew
This is optional as you can download things without, but Homebrew is a simple set of command line tools that make the process easier. We recommend downloading it if you haven't already.
Expand Down
11 changes: 5 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,16 @@
"tauri": "tauri",
"macapp": "tauri build --verbose",
"winapp": "tauri build --target x86_64-pc-windows-gnu",
"copy-pdf-worker": "cp node_modules/pdfjs-dist/legacy/build/pdf.worker.min.js public/pdf.worker.min.js",
"copy-pdf-worker": "shx cp node_modules/pdfjs-dist/legacy/build/pdf.worker.min.js public/pdf.worker.min.js",
"eject": "react-scripts eject",
"dist": "electron-builder",
"start": "npm run copy-pdf-worker && react-scripts start",
"build": "npm run copy-pdf-worker && react-scripts build && echo 'candlestickers.app' > ./build/CNAME;",
"build-engine": "cd engine; mkdir dist/; gulp; cp -a dist/. ../public/corelibs/wick-engine/",
"build-engine-windows": "cd engine & mkdir dist 2>nul & gulp & xcopy /EY dist\\. ..\\public\\corelibs\\wick-engine\\",
"build-engine": "cd engine && shx mkdir -p dist && gulp && shx cp -r dist/. ../public/corelibs/wick-engine/",
"test": "react-scripts test",
"engine-tests": "cd engine; python -m SimpleHTTPServer 9999",
"predeploy": "npm run build",
"prerelease-deploy": "npm run build; cp -r build/* ../wick-editor-prerelease/; cd ../wick-editor-prerelease; rm CNAME; echo 'test.candlestickers.app/' > CNAME; git add .; git commit -m 'update prerelease build'; git push --force;",
"prerelease-deploy": "npm run build && shx cp -r build/* ../wick-editor-prerelease/ && cd ../wick-editor-prerelease && shx rm CNAME && echo 'test.candlestickers.app/' > CNAME && git add . && git commit -m 'update prerelease build' && git push --force;",
"build:nocname": "react-scripts build",
"check-branch": "node -e \"const {execSync}=require('child_process'); const b=(process.env.GITHUB_HEAD_REF||process.env.GITHUB_REF_NAME||execSync('git rev-parse --abbrev-ref HEAD')).toString().trim(); if(b!=='development'){console.error('✖ Deploy test only from development (current: '+b+')'); process.exit(1);} console.log('✔ Branch ok:', b);\"",
"check-branch-prod": "node -e \"const {execSync}=require('child_process'); const b=(process.env.GITHUB_HEAD_REF||process.env.GITHUB_REF_NAME||execSync('git rev-parse --abbrev-ref HEAD')).toString().trim(); if(!['main','master'].includes(b)){console.error('✖ Deploy to prod only from main/master (current: '+b+')'); process.exit(1);} console.log('✔ Branch ok:', b);\"",
Expand All @@ -130,8 +129,8 @@
"package-mac": "npm run build; electron-builder --mac",
"package-windows": "npm run build; electron-builder --windows",
"package-linux": "npm run build; electron-builder --linux",
"phonegap-deploy": "npm run build; cd ../wick-editor-phonegap; npm run prepare-dir; cd ../wick-editor; cp -r build/* ../wick-editor-phonegap/www; cd ../wick-editor-phonegap; npm run prepare-app; git add .; git commit -m 'update phonegap build'; git push --force;",
"phonegap-predeploy": "npm run build; cd ../wick-editor-phonegap; npm run prepare-dir; cd ../wick-editor; cp -r build/* ../wick-editor-phonegap/www; cd ../wick-editor-phonegap; npm run prepare-app;"
"phonegap-deploy": "npm run build && cd ../wick-editor-phonegap && npm run prepare-dir && cd ../wick-editor && shx cp -r build/* ../wick-editor-phonegap/www && cd ../wick-editor-phonegap && npm run prepare-app && git add . && git commit -m 'update phonegap build' && git push --force;",
"phonegap-predeploy": "npm run build && cd ../wick-editor-phonegap && npm run prepare-dir && cd ../wick-editor && shx cp -r build/* ../wick-editor-phonegap/www && cd ../wick-editor-phonegap && npm run prepare-app;"
},
"eslintConfig": {
"extends": "react-app"
Expand Down