Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peopledoc/pileple-skeleton
Skeleton based on Pileple stack!!!
https://github.com/peopledoc/pileple-skeleton
approved-public ghec-mig-migrated legacy tribe-js
Last synced: 17 days ago
JSON representation
Skeleton based on Pileple stack!!!
- Host: GitHub
- URL: https://github.com/peopledoc/pileple-skeleton
- Owner: peopledoc
- License: mit
- Created: 2014-09-29T15:55:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-12-05T10:13:10.000Z (about 10 years ago)
- Last Synced: 2024-04-16T06:52:51.660Z (9 months ago)
- Topics: approved-public, ghec-mig-migrated, legacy, tribe-js
- Language: JavaScript
- Size: 619 KB
- Stars: 0
- Watchers: 42
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pileple Skeleton :skull:
Skeleton based on Pileple (https://github.com/novapost/Pileple) stack!!!
## Dependencies
You need to have `npm`, `grunt-cli` and `bower` installed.
And you need `livereload` if you want to develop easily.
### Install npm
If your are on a debian-based OS, you can try:
```shell
(root) apt-get/aptitude install npm nodejs
```
### Install grunt-cli and bower
When `npm` is installed:
```shell
(root) npm install -g grunt-cli bower
```
### Install livereload
It's a plug-in for your browser which auto-reload when grunt successfully compile something on-the-fly:
http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-
## What is the environment?
Folder tree:
- `app`: contains the whole application
- `app/js`: contains the JavaScript application based on Backbone + Marionette
- `app/locales`: contains the locales (i18n)
- `app/static`: contains the static website to help in development
- `app/style`: contains the LESS style
- `app/template`: contains the Jade with Handlebars templates
- `dist/`: The minimized build of the application
- `.tmp/`: The temporary directory for development or temporary building file
The environment is based around the tool `grunt`.
All the configuration is inside `Gruntfile.js`.
Grunt Works with rules, it is a tool similar to make but oriented JavaScript environment.
We can separate the grunt rules of this project into three parts:
- Tests: ```grunt test```
1. Launch JSHint tool into the whole project.
2. :soon: Unit Tests...
- Build: ```grunt build```
Build the application with everything compress into `dist` directory.
- Development: ```grunt serve```
1. Build the application on debug mode with static file (demo website) into `.tmp` directory.
2. Start the server with livereload and open your browser.
3. Watch for modification in the application, style, locales or static files and rebuilt what is necessary.
The default rule ```grunt``` launches test and build.
## Setup the environment
```shell
(user) npm install
(user) bower install
```
## How to build
```shell
(user) grunt
```
## How to dev
Run grunt with compilation on-the-fly:
```shell
(user) grunt serve
```
### Backbone and more
- BackboneJS: http://backbonejs.org/
- UnderscoreJS: http://underscorejs.org/
- Marionette: http://marionettejs.com/
- Backbone Relational: http://backbonerelational.org/
- jQuery: https://jquery.com/
### Template
We use Jade template with Handlebars syntax inside.
That's why the compilation is done in two time:
- Jade compilation into simple HTML with Handlebars.
- Handlebars compilation into JST.
Some usefull links:
- HTML to Jade converter : http://html2jade.org/
- Jade-Lang: http://jade-lang.com/
- Handlebars: http://handlebarsjs.com/
### LESS Style
- LESS: http://lesscss.org/
### Internationalization (i18n)
- i18next: http://i18next.com/
## How to integrate :v:
In your website, you can include this code.
The alias name `pilepleSkeleton` is generated thanks to the field `name` inside `package.json`.
```html
var pilepleSkeleton = require('pilepleSkeleton');
window.PilepleSkeleton = pilepleSkeleton;
$(document).ready(function() {
PilepleSkeleton.start({
lang: 'fr',
libPath: './'
});
});
```
## License
MIT
See the LICENSE file for full text