search

scottdurow / SparkleXrm

An open-source library for building Dynamics CRM XRM solutions using Script#, jQuery & Knockoutjs.
MIT License
265 stars 198 forks source link

Is there basic documenation describing how Sparkle and Script# work #127

Open larrywelch opened 7 years ago

larrywelch commented 7 years ago

I am very interested in using Sparkle and Script#. I've spent a couple of days building the Sparkle Samples but I could use a simple explanation of how the ClientHook and ClientUI projects interact with the CrmPackage project. I believe the Script# and Knockout JS play a part in all of this but I'm not sure.

Any documentation on Sparkle and/or Script# will be appreciated.

Also, is Sparkle well supported at this time?

scottdurow commented 7 years ago

The ClientHooks and ClientUI projects transpile into the ClientHooks.js and ClientUI.js in the CrmPackage project - this allows you to easily deploy the JavaScript.

Script# is the component that does the transpiling of C# into JS KnockoutJS is the component that enables the MVVM data binding pattern for the ClientUI project - but it is not used in the ClientHooks because this is purely for code on Forms/Ribbon Commands etc.

There are some tutorials at http://www.sparklexrm.com/s/tutorials.html - but I'd like there to be more documentation. At the moment it is development over documentations - but there needs to be more resources for learning the basics. If you feel that way inclined it would be great if you could help with this?

larrywelch commented 7 years ago

Thanks for the information. I am interested in participating and would be happy to focus on documentation as I adopt the tools. 

scottdurow commented 7 years ago

@larrywelch That would be fantastic - you could add to the exiting wiki - https://github.com/scottdurow/sparklexrm/wiki

larrywelch commented 7 years ago

I found the connection in the ClientUI/ClientHook projects. It’s in the output path on the build tab.

larrywelch commented 7 years ago

I’ll begin compiling my notes and learnings and then contribute.

One simple question – How does the ClientUI/ClientHooks projects tie to the CRMPackage Solution? I don’t see anywhere in the project files or the class files to specify an output project or a link in any way?