Skip to content
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.

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

APE_JSF refactor #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

APE_JSF refactor #17

wants to merge 1 commit into from

Conversation

lcharette
Copy link
Collaborator

Here's a little something I planed while working on the new website. I find the current JSF hard to work with. Even I sometimes have hard time starting a new APE page without having to look at demos or the wiki on how to start. I also find stupid the default setup doesn't use the build client version. I made theses changes to make JSF more easy to start with. I bundle it as v.1.2 for clarity. I finnaly took example on Pablo's client structure (https://github.com/ptejada/ApePubSub)

Here's what changed:

  • Changed the build folder to js/
  • Moved the Source folder inside js/src/Core/Sources
  • Moved the uncompressed Core source to js/src/Core/Combined
  • Kept the yui compresses sources as the main, renamed as .min.js
  • The combined version of the Core files with Sessions support only contains the sessions code instead of all the core code.
  • Updated Tools/Check
  • Updated Demos

Basically, one who want to deploy the JSF upload the "js" folder to his server (without /src) and he's good to go with those 4 files:

  • apeClient.min.js
  • apeConfig.js
  • apeCore.min.js
  • apeCoreSession.min.js

Pros:

  • Mark the seperation between Client/Core, Client/Mootools and Core/Mootools-core more clearly (The current default client is named Mootools.js. Someone who wan't to use JQuery on his page for example could delete the Mootools.js file...)
  • The javascript client is now the default one. This means Mootools-core doesn't have to be included by default. JQuery is the most popular choice nowadays, I think it make more sense this way. The Mootools client is still there (in /js/src/Client), but one could use Mootools for UI and still use the Javascript client (See Chat Demos)
  • Simplified the sessions support. Uncomment one line in the config, or add in the HTML (See the Chat demos) to enabled Sessions support. A config value would be ideal, but requires more work.

Cons:

  • Probably not compatible with Peter's pull request (https://github.com/APE-Project/APE_JSF/pull/16/files). Btw, I don't have access to this repo, I can't merge pull request. Instead of merging this pull request, I could also start over from Peter's one, no big deal.
  • Documentation and wiki probably have to be updated too.

Let me know what you think. or if you have any suggestions !

See pull request for more info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant