Beginner Questions

[Dunk Fordyce]

@z3dev a desktop viewer requires a whole lot of desktop whereas a web viewer can be viewed from any machine on the same network trivially. I'm guessing here: a web server setup is going to be alot smaller than requesting electron or whatever else is used. I'd go even further and say that the desktop viewer should always just be the web viewer wrapped up in electron with any features that cant be done in a browser.

Having the CLI tools there would certainly be good, I had forgotten about those.

[z3dev]

• scripts: is there a command that runs a web server with a viewer? I know about npm run dev in the www package but that's not what we want.

I think this would be the desktop application, which doesn’t exist yet for V2.

• dependencies: It seems correct to include this so that is a totally valid package, but perhaps it should just include the typescript definitions. I'm not sure

It probably depends on the IDE.
Does anyone have a suggestion?

• devDependencies: a viewer seems like a good thing for development, certainly for a template

CLI is an alternative, but viewing the results makes more sense.

[z3dev]

@Dunk-Fordyce your points are fair.

The parameters are still closely tied to HTML input types. There’s a whole new world now with V2 so please be frank and propose some innovative changes.

There should be reinforcement of the JavaScript language, so defaults should be useable. Definitely an area to explore.

[Dunk Fordyce]

@z3dev

I didnt get very far...

{
  "name": "machinez1",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "run": "...cmd to launch a webserver with the viewer"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@jscad/modeling": "^2.0.0-alpha.9"
  },
  "devDependencies": {
    "@jscad/web": "^2.0.0-alpha.9"
  }
}

• scripts: is there a command that runs a web server with a viewer? I know about npm run dev in the www package but that's not what we want.
• dependencies: It seems correct to include this so that is a totally valid package, but perhaps it should just include the typescript definitions. I'm not sure
• devDependencies: a viewer seems like a good thing for development, certainly for a template

[Dunk Fordyce]

@z3dev Ok, I just wondered if I was missing something.

Personally it seems a shame that the defaults are tied to the parameters function instead of where they should be ie:

const main = ({radius=10}) => { }
// or
const main = (radius=10)  => {}
// etc

But how that would work with parameter definitions is a another thing...

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

Also:

• how can I use the parameter defaults from another file? It seems getParameterValuesFromParameters should be exposed somewhere?

There are several ways but no general practice. I'm porting a project which has several designs for gears (very nice designs). And here's one way to put those together into one BIG design.

const bevelParams = require('./bevelGear').getParameterDefinitions
const bevelGear = require('./bevelGear').main

// combine parameters definitions

const getParameterDefinitions = () => {
  const definitions = [
  ]
  // bevel gear parameters
  definitions.push({ name: 'bevelGear', type: 'group', caption: 'Bevel Gear' })
  definitions.push(...bevelParams())
  return definitions
}

const main = (params) => {
  return bevelGear(params)
}

module.exports = { main, getParameterDefinitions }

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

I understand how the project structure is meant to be now but is there, or could there be, a template git repo with the correct files included for linting and other nice to have things?

If I understand correctly, a template for new design projects. Nice idea!

Just clone and go.

Maybe a new project on the JSCAD community would be a good place for this.

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

i want to add a vector type to the params, is there anything wrong with adding that into packages/web/src/ui/views/parameterControls.js or are your vue controls about to make it obsolete?

Interesting. Nothing is planned for the parameters, except some re-factoring of code. A new type of parameter would be fine if it works across CLI/WEB applications.

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

will you support js import/export statement instead of require?

Definitely. Browsers (and Node) are moving forward with import/export, and JSCAD will follow.

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

whats happening with the vue components I've seen in your vue-components repo ( I like vue )

Excellent! I will be maintaining those going forward, but would appreciate any assitance or comments. I'm just a Vue beginner, and probably have a whole lot wrong.

[Dunk Fordyce]

Also:

• how can I use the parameter defaults from another file? It seems getParameterValuesFromParameters should be exposed somewhere?

[Dunk Fordyce]

Ok, I have the following questions, is here appropriate to ask?

• whats happening with the vue components I've seen in your vue-components repo ( I like vue )
• will you support js import/export statement instead of require?
• i want to add a vector type to the params, is there anything wrong with adding that into packages/web/src/ui/views/parameterControls.js or are your vue controls about to make it obsolete?
• I understand how the project structure is meant to be now but is there, or could there be, a template git repo with the correct files included for linting and other nice to have things?

[z3dev]

@Dunk-Fordyce said in Beginner Questions:

@z3dev Thanks!

This works great!

Is there a discord or slack or even IRC channel for jscad?

Not that I know about.

[Dunk Fordyce]

@z3dev Thanks!

This works great!

Is there a discord or slack or even IRC channel for jscad?

[z3dev]

@Dunk-Fordyce Sorry. I forgot to mention that the auto-reload function works really welcome with Chrome.

Just enable Auto-reload then drag and drop a file or a folder (project). Any changes will automatically be detected and reloaded.

[z3dev]

@Dunk-Fordyce Welcome!

A great question!
The management of projects is getting better in V2, and you can find more information on the V2 User Guide. See the Projects section.

(It’s been work in progress so please make changes!)