GithubHelp home page GithubHelp logo

yuki-transmedia's Introduction

Yuki le panda roux

Ce repository git contient l'application Yuki-transmedia, narrant l'aventure de Yuki le panda roux à travers les différents chapitres.

Installation

Ouvrez Babun ou un autre terminal unix, et tappez

$ git clone -b dev [email protected]:michaelz/yuki-transmedia.git # Cloner la branch dev directement
$ cd yuki-transmedia
$ npm install

Lancer l'application

$ grunt

GIT Workflow

Utilisation de git pour tous les membres de l'équipe.

Nous utilisons la fonctionnalité des branches dans git. La branche master est utilisée pour la production. Une branche dev a été créée pour le serveur de développement.

Pour chaque nouvelle fonctionnalité, il faut créer une nouvelle branche, basée sur la branche dev, avec la commande suivante :

$ git checkout -b nom_de_la_branche --track origin/dev

Ceci va créer une nouvelle branche nom_de_la_branche et switcher dessus.

La procédure pour les commits reste la même que d'habitude, sauf au niveau du "pull".

$ git commit -am "mon message de commit très important car public" # commit
$ git pull --rebase # correspond à un 'git fetch' suivi d'un 'git rebase' --> mieux que juste git pull, ça évite les merges
$ git push origin nom_de_la_branche # va pousser les modifications sur notre branche vers origin (= github)

Une fois que la fonctionnalité est terminée, il faut merger le nouveau code avec la branche dev. Pour cela, on va faire un pull request depuis Github directement.

Le pull request doit être fait entre dev et nom_de_la_branche, et pas avec master. Une fois le pull request crée, on peut contrôler que tout est ok sur Github et merger les modifications.

On a le choix de garder notre branche ou de la supprimer une fois que c'est mergé (si la fonctionnalité n'est pas terminée par exemple mais qu'on a quand même envie de voir les modifications sur dev).

C'est M qui s'occupe de mettre en production (= merger dev sur master et fetcher sur le serveur).

Plus d'information sur le rebase sur coderwall.com

Développement

Backend

Le développement backend peut directement s'effectuer dans le dossier

Frontend

Les fichiers sont dans le dossier resources. Ils seront copiés dans le repértoire /public/. Il ne faut donc modifier le contenu de ce dernier repértoire !

Documentation

La documentation backend (api routes) est accessible sur /doc. Les commentaires au dessus des controllers se fait de cette manière:

 /**
  * @api {get} /user/:id Request User information
  * @apiName GetUser
  * @apiGroup User
  *
  * @apiParam {Number} id Users unique ID.
  *
  * @apiSuccess {String} firstname Firstname of the User.
  * @apiSuccess {String} lastname  Lastname of the User.
  */

Source: apidocs.com

yuki-transmedia's People

Contributors

michaelz avatar flavz27 avatar gmeylan avatar denich08 avatar guzidev avatar numakensch avatar valblackhornet avatar

Watchers

James Cloos avatar Timothée Floure avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.