MediaSignage support forum

community support => Open source Digital Signage => Topic started by: rknight on February 14, 2014, 11:40:10 AM

Title: Open Source Docs for Newbies
Post by: rknight on February 14, 2014, 11:40:10 AM
Is there any documentation for newbies on learning how to customize your own studio lite and player?

All the docs I see look like only a reference to the modules code.

I'm looking for a tutorial like doc that walks you through on how to do it.

Anything like that?

Thanks
Title: Re: Open Source Docs for Newbies
Post by: admin on February 14, 2014, 06:33:17 PM
The StudioLite open source is definitely designed for developers and all docs are set for that type of audience.
However I do have a simple solution for you, hire an outsourcing guy from www.freelancer.com
You will find lots of inexpensive talent that will be able to help and re-factor / customize the app.
Just look for a JavaScript developer with experience in Backbone framework... simple as that!

Regards.
Title: Re: Open Source Docs for Newbies
Post by: rknight on February 18, 2014, 07:07:13 AM
I downloaded the files from github and posted them to my server, thinking that's all I needed to do, but when I open the studiolite.html from my server, I dont see the login fields.  I just want to see if I can get the studio lite to run the way it is from our server. Can I do that?

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on February 18, 2014, 08:36:27 AM
provide a link so I can checkout...
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 04, 2014, 12:19:16 PM
Here's the link: http://www.quikmedia.tv/sslite/studiolite.html

All I did was download the files and upload them.

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on March 04, 2014, 07:21:57 PM
you are using an old version of the git repo, download new version from GitHub and re-copy to your server.
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 05, 2014, 05:35:43 AM
How did you know it was an old version? I just downloaded it yesterday. How can I verify that I have download the latest version?

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on March 05, 2014, 10:25:46 AM
Look at the bottom of App: version 0.6.347 as of today.
You may need to update once more as we just added version numbering.
We release builds daily so I recommend automating the process.
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 05, 2014, 12:08:54 PM
I just downloaded a new zip and uploaded it....and I still can't see the login fields?

My version says " version 0.6.:BUILD:"

????

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on March 05, 2014, 09:53:05 PM
you can see the latest version in our studio: https://secure.dynawebs.net/_studiolite-dist/studiolite.html
which will alwats be the same as posted on Git
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 06, 2014, 05:48:41 AM
on my page it looks like the where the build number should be, it's showing ":BUILD:"

Like I said I downloaded the ZIP file with files and uploaded them directly to a directory on our server. But for some reason it's not working like yours.  I'm pretty sure I downloaded the current version.

Still stumped

Robert

Title: Re: Open Source Docs for Newbies
Post by: admin on March 06, 2014, 10:14:26 AM
yes the :BUILD: is something we have internally on our server so you won't see that on your side.
You can just remove it from the HTML, and you can check our studio for reference on what is the latest build number.
FYI, the build changes a few times a day as this is active development so I wouldn't even worry about the number and instead just automate a process to auto pull from Git on weekly basis...
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 06, 2014, 10:22:15 AM
Back to my initial problem.
the login fields are not showing on my server

Here's the link: http://www.quikmedia.tv/sslite/studiolite.html

the :BUILD: number is probably not showing because there's something wrong.

What is the problem?

RObert
Title: Re: Open Source Docs for Newbies
Post by: ANOOP on March 06, 2014, 10:34:34 AM
I am waiting for Robert to say its working so that i can start retrying  ;D
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 06, 2014, 10:41:41 AM
What problems are you having ANOOP?
Title: Re: Open Source Docs for Newbies
Post by: ANOOP on March 06, 2014, 08:47:12 PM
The same problem you are facing the login screen doesnot appear and when i try inspect element in the browser it shows js error. Did all manipulations just doesnt work though
Title: Re: Open Source Docs for Newbies
Post by: JMH on March 07, 2014, 05:07:15 AM
I had the same problem. Fixed it like this:
Add a folder in the root (where folders like _assets, _collections, etc. are placed) named: _studiolite-dev.
Add the following folders and files in this folder (i copied):
_assets
_collections
_common
_controllers
_libs
_models
_utils
_views
Element.js
Init.jes
StudioLite.js

Tadaaa! Login screen appears.

Now my problem is, that I am not able to modify the css and other files in a way so I can easily update to newer version without having to start editing all over again (like translating the language and other stuff). Who can point me in the right direction? :)
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 07, 2014, 05:54:32 AM
That didn't work for me, JMH.

So, Admin whats the issue..... All I'm doing to downloading the files from GitHub and uploading them to my server. I'm not modifying the files in any way yet. I just wanted to see if it works first before I did any customizing.

Is there anything else that needs to be done with the Files from Github before I upload them to my server?  Like change paths in the studiolite.html file for javascript and css.

I'm sure there's gotta be a simple reason why the BUILD number and login fields are not showing.

Please help ADMIN

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on March 07, 2014, 08:22:51 AM
JMH, provide a link so we can checkout.

Anoop,
we will release localization in the next few weeks so hold off on implementing it.
As for other changes, you can override CSS but you will need to maintain it as things are still changing rapidly and you will be bound to our release cycle changes.
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 07, 2014, 09:40:13 AM
Admin is just ignoring me now
Title: Re: Open Source Docs for Newbies
Post by: admin on March 07, 2014, 11:26:30 AM
what's your link rknight?
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 07, 2014, 11:29:17 AM
http://www.quikmedia.tv/sslite/studiolite.html
Title: Re: Open Source Docs for Newbies
Post by: admin on March 07, 2014, 05:21:25 PM
you are getting an error of:

Failed to load resource: the server responded with a status of 404 (Not Found) http://www.quikmedia.tv/_studiolite-dev/StudioLite.js
Uncaught Error: Script error for: StudioLite
http://requirejs.org/docs/errors.html#scripterror require.js:166
makeError require.js:166
context.onScriptError

make sure to host it under studiolite-dev
Title: Re: Open Source Docs for Newbies
Post by: JMH on March 08, 2014, 05:29:28 AM
As admin states above: You have to add StudioLite.js to the _studiolite-dev folder. Press F12 in Chrome and you will see the error.

My link is: :www.dslite.dsigne.nl, you can check it out if you want.
Currently I am not running the newest version, because as I mentioned in my earlier post, I am not able to modify the looks and lay out in such a way that it will keep that way after an update.
Title: Re: Open Source Docs for Newbies
Post by: rknight on March 11, 2014, 12:20:02 PM
I change the folder name that I had the studio lite files in from "sslite" to "_studiolite-dev"

So, my old url was... http://www.quikmedia.tv/sslite/studiolite.html

Now it's... http://www.quikmedia.tv/_studiolite-dev/studiolite.html

So finally I can see the login fields. But the build number is still not showing. Any way to get that to show?  All I see is the variable for it ":BUILD:"

Also...Do you always have to put your Studio Lite files in a directory named "_studiolite-dev"???

Robert
Title: Re: Open Source Docs for Newbies
Post by: admin on March 11, 2014, 04:39:15 PM
First, this is open source... so there is no "Have to" on anything... you can customize all you want...
And, build numbers are only for release builds, not dev... thus you do not get any data as it is only for release builds hosted on our site, you can setup your own release cycle and your own release builds.

Second, we release a new version daily... so I recommend automating the process of grabbing from Git as well as some scripts to override your specified changes (a merge script)

Third, you can name the directory anything you want (no need for studio-dev) but you will need to modify the require.js init scripts and possibly a few other places (search and replace can come real handy).
Title: Re: Open Source Docs for Newbies
Post by: JMH on March 13, 2014, 03:03:32 AM
Yes, ofcourse we can edit the folder names. But what happens if there is a new version? Than we have to edit these files all over again right?
Title: Re: Open Source Docs for Newbies
Post by: admin on March 13, 2014, 11:20:45 AM
Keep in mind the SignageStudio lite as well as its related SDK Jalapeno are undergoing daily development and so you will lose any changes you make to your code if you overwrite it with our release builds.

To overcome this you can follow these guidelines:

1.   Always be sure to override files and not modify the original source file. This is true for both CSS and JavaScript code. Simply load your version of the CSS after ours to apply your latest changes. HTML files can be diffed (see below).

2.   Our code base is modulated and uses 100% object oriented design pattern. This allows you to sub class (aka inherit) from our classes and make your applied changes (use _.extend to mixin).

3.   You can also use pre-processor scripts which replace code segments automatically using directives.

4.   And finally, even while following steps 1-3 you may find that your code is broken due to design changes in the original repository. That’s when GitHub comes to the rescue. When your fork the source repository, you can always merge the tree onto your forked project. Use source control diff tool to merge the changes into your code and resolve any conflicts.

With the above steps you can ensure that your source code is fully customizable while still keeping it synchronized with our ongoing development efforts.

And of you built something wonderful, just send us a pull request and we can evaluate it. If we like what you did we we will merge it into our code base, so you will always receive it when you fetch our changes.

If you are not a developer you can hire professional, inexpensive help from sites like oDesk and Freelancer. Just post you are looking for a JavaScript, jQuery, Backbone experienced developer.