Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geolffreym/syrup

App with sweet flavor.
https://github.com/geolffreym/syrup

framework javascript syrup

Last synced: about 1 month ago
JSON representation

App with sweet flavor.

Awesome Lists containing this project

README

        

Syrup ([v0.1.0-alpha](https://en.wiktionary.org/wiki/alpha_version))
=======
App with sweet flavor

Content
=======

* [Syrup Core](https://github.com/geolffreym/Syrup/blob/master/readme/CORE.md)
* [About Design and Features](https://github.com/geolffreym/Syrup/blob/master/readme/ABOUT.md)

(Pending Documentation)

Compatibility with browsers
---------------------------

-IE > 10
-Chrome > 32
-Firefox > 29
-Opera > 23
-Safari > 7

Controlling browsers support.

```js
if(_.nav.unsupported){
//What to do?
}
```
*If there is any browser incompatibility please notify*

Installation
-----------

Using [Bower](http://bower.io/):

`bower install syrup`

Using [Git](http://git-scm.com/docs/git-clone):

`git clone https://github.com/geolffreym/Syrup.git`

Config
------
Configuration is very simple, you just have to access the folder /config/ and edit the file init.js

You need to set the 'app_path' and 'system_path', which is responsible for establishing relative directories. The default is '/' and finally, the environment which can be either development or production.

```js
//config
var setting = {
app_path : '/syrup/app',
system_path: '/syrup/system',
env : 'development'
};
```


Joining files
-------------

**Node JS Required**

Blend files is relatively simple, you must first establish the libraries you want to use in environment.

Syrup is modular so you can create your own libraries and integrate the autoloader

```js
//Development
exports.files = {
js: {
output: 'dist/init', //The output
src: [
'app/config/init', // Needed do not change
'system/base/init', // Needed do not change
// 'lib/Form',
// 'lib/Upload' // Add all the necessary scripts for startup
]

}
}
```

Then you must get packages with `npm install` and finally run `npm start` and you'll have a unified library and .min in folder /dist/

*If you do not have the option of using node, you must manually change the settings in the /dist/init.js and include libs separately*