evolus / pencil

The Pencil Project's unique mission is to build a free and opensource tool for making diagrams and GUI prototyping that everyone can use.
http://pencil.evolus.vn
GNU General Public License v2.0
9.03k stars 715 forks source link

Newbie problems following README.md setup instructions for development #770

Open donPab opened 1 year ago

donPab commented 1 year ago

In a Win10 setting with VSCode, as a beginner, I am having a hard time following this setup sequence.

In 2--which repository is to be cloned? Electron? or Pencil? Can 1 & 2 be combined into one sentence? The link goes to https://www.electronjs.org/ which has buttons for Releases and GitHub Why does Electron need to be cloned ? Where in this startup do we make reference to the cloned folder? Since 6&7 npm install, which includes Electron dependencies, comes directly from "GitCentral".

In 3--How do I make sure nodejs 5+ is being used? Is this ES level? or node -v (which is now > 18)? I can't find any indication of ES level in any node commands. Are all node versions now in 2023 at level 5+ ??

In 4 & 5--git : The term 'git' is not recognized as the name of a cmdlet. Is git required to be installed? Or will github be ok? I am still trying to github the development 3.1.2 version into a folder C:\H_Paul\Pencil312 ... and not finding the right args.

In 6 & 7--do I need to CD (Change Directory) to the Pencil/App folder before installing? -- from: https://www.stackchief.com/tutorials/npm%20install%20%7C%20how%20it%20works -- see also: https://docs.npmjs.com/cli/v8/commands/npm-install When run without arguments, npm install downloads dependencies defined in a package.json file and generates a node_modules folder with the installed modules. It's important that npm install is run in the same location as the package.json file. npm install also generates a package-lock.json file.

In 8 & 9--This runs the "start" property of a package's "scripts" object. npm start -->runs--> "start": "./node_modules/.bin/electron ./app" Is this suitable only for Linux, and not for Windows? When I do npm start, I get these output results ==>terminal==> npm start

start ./node_modules/.bin/electron . '.' is not recognized as an internal or external command, operable program or batch file. (1st dot, before /node) ==>What is the correct start, and what is the first Pencil program to be executed?
In VSCode, I tried to use launch.json to startup, and that only displayed a white screen with the flashing P logo. I would like to get the development version up & running on Win10. tkx, donPab

donPab commented 1 year ago

No longer a problem.
I researched other issues, i.e. #590 and #236 Where they did not explicitly follow the ReadMe instructions. And I went back and did exactly as per ReadMe, -- --> sorta.

github clone https://github.com/evolus/pencil.git -- worked, but it got the Master 3.1.1 github clone -b development https://github.com/evolus/pencil.git --git branch worked, I changed folder to Pencil312

npm install -- created many lines of Warnings, and cleanup failed to remove 2 directories, errno: -4048, npm audit fix -- was run, with many lines of output

npm start -- failed,

Pencil@3.1.2 start ./node_modules/.bin/electron . '.' is not recognized as an internal or external command

"star1": ".\node_modules\.bin\electron .", -- was added to package.json in scripts section npm run star1 -- worked, even found C:\Users...\config.json pointer to prior epgz drawing files

Pencil@3.1.2 star1 .\node_modules.bin\electron . Background web-printer started. Shortcut main service started. Shortcut: Super+F12 registered RENDERER started. [17908:0305/233504.514:ERROR:gpu_init.cc(457)] Passthrough is not supported, GL is disabled, ANGLE is

I will try a revised start:dev and continue with developing Bezier.