Créez, modifiez et hébergez votre propre Back-office Kiubi
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
dist
src
.gitignore
.jsbeautifyrc
.jshintrc
LICENSE
README.md
package-lock.json
package.json

README.md

Back-office Kiubi

Créez, modifiez et hébergez votre propre Back-office Kiubi sous forme d'une application web qui exploite pleinement l'API Developers.

VERSION ALPHA

Vous utilisez actuellement une version alpha de l'application back-office qui reste sujette à certains dysfonctionnements. Par conséquence, il est important de ne pas l'utiliser sur un site Internet en production mais uniquement sur un site dédié aux tests. Certains modules ne sont pas encore disponibles ou fictifs (dashboard, catalogue, commandes...) et seront ajoutés ultérieurement.

N'hésitez pas à nous faire des retours, positifs comme négatifs ! Tout commentaire, suggestion, remontée de bugs sont les bienvenus !

Démo

Vous trouverez une version démo fonctionnelle à l'adresse : https://alpha.kiubi.com

Débuter

L'application compilée est déjà disponible dans le dépôt. Si vous disposez déjà de npm et de python, vous pouvez démarrer le serveur web de test et y accéder avec votre navigateur par http://localhost:8000/

$ npm run start

Dans le cas contraire, il faudra trouver une petite place sur un serveur web et consulter la partie "Hébergement" ci dessous.

Les mains dans le cambouis

L'application utilise le framework Marionette JS. Pour compiler l'application à partir de ses sources, il est nécessaire d'installer d'abord ses dépendances :

$ npm install
$ npm run build

Un micro serveur web Python est inclus pour faciliter le développement. Il se lance sur le port local 8000 à l'aide de la commande :

$ npm run start

Fichiers

  • Sources : src/
  • Outils de compilation et de developpement : bin/
  • Webapp compilée pour la production : dist/

Hébergement Apache

Exemple de virtual host (remplacer [PROJECT] par le chemin du dépot git) :

Listen 8080
<VirtualHost *:8080>
   DocumentRoot [PROJECT]/dist

   RewriteEngine On

   RewriteCond %{REQUEST_FILENAME} !-f
   RewriteRule .* /index.html
</VirtualHost>

Hébergement Nginx

Exemple de virtual host (remplacer [PROJECT] par le chemin du dépot git) :

server {
    listen 8080;

    location / {
        root [PROJECT]/dist;
        try_files $uri /index.html;
    }
}

Compilation automatique

Le script watch permet d'automatiser la compilaton de sources dès qu'un changement est détecté dans le répertoire src. Cela évitera de devoir lancer manuellement un npm run build à chacune de vos modifications. Il suffit d’installer des dépendances complémentaires et de lancer le script qui va tourner en tâche de fond.

$ npm install -g catw watchify
$ npm run watch

Et avant de faire un commit, un peu de mise en forme ne ferra pas de mal ;)

$ npm run js-beautify

Licence

Ce code source est distributé sous Licence MIT.