Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LoicTouzard committed May 23, 2016
1 parent 2dd2408 commit 8d20dc8
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 45 deletions.
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
# MapIf
Où sont les IIIIIF ?
Où sont les IIIIIF ? ICI --> [mapif en ligne](http://mapif-insa.rhcloud.com)
![Mapif-logo](src/static/favicon.png "Mapif-logo")
## Le projet

Ce projet à pour but de recenser la position des IFs.
Ce projet est né de l'esprit de quelques 4IF au moment critique qu'est le stage, veille du départ en échange pour une majorité d'entre eux. Cette épreuve qu'est la séparation n'étant pas facile à vivre, ils ont décidé de développer cette petite application permettant de connaître la position d'autres IF des endroits où se trouvent leurs amis et où ils se trouvent eux mêmes.

Les objectif sont décrits dans le [cahier des charges](doc/cdc.md)
## Contribuer

### Qu'est ce qu'il y a la dedans ?
* [jQuery 2.2.3](http://jquery.com/)
* [Bootstrap 3.3.6](http://getbootstrap.com/)
* [Bootstrap Material Design](http://fezvrasta.github.io/bootstrap-material-design/)
Si vous avez une idée de fonctionnalité, n'hésitez pas a l'implémenter ou à la partager dans les [issues](https://github.com/LoicTouzard/MapIf/issues).

### De quoi j'ai besoin ?
* [Python 3](https://www.python.org/downloads/) et l'installateur de package python `pip` correspondant
## Environnement de développement

* [Flask](http://flask.pocoo.org/)
### Back

Le code du serveur est développé en [Python 3](https://www.python.org/downloads/) compatible avec la version `3.3` pour permettre son déploiement sur [OpenShift](https://www.openshift.com).
Le back utilise [Flask](http://flask.pocoo.org/), et d'autres librairies python renseignées dans le fichier [requirements.txt](requirements.txt).
Installez les dépendance en executant `pip install -r requirements.txt`
Vous aurez besoin également de créer le fichier de configuration `mapif.ini` pour ce, prenez exemple sur le fichier [mapif.ini.dist](mapif.ini.dist).

### Front

Le front est développé en [HTML5](http://www.w3schools.com/html/html5_intro.asp), [CSS3](http://www.w3schools.com/css/css3_intro.asp), [javascript ECMA5](https://developer.mozilla.org/fr/docs/Web/JavaScript/Language_Resources).
Le code exploite principalement [jQuery 2.2.3](http://jquery.com/) pour la gestion des évènements et animations, [Leaflet.js](http://leafletjs.com/) pour la gestion de la carte, et [Nominatim d'OpenStreetMap](http://nominatim.openstreetmap.org/) pour la résolution d'adresse.
Pour le style il s'agit de [Bootstrap 3.3.6](http://getbootstrap.com/), augmenté du [Bootstrap Material Design](http://fezvrasta.github.io/bootstrap-material-design/).

## Contributeurs / Remerciements
Projet à l'initiative de [Nicolas Bonfante](https://github.com/niosega).
Réalisation par [Loïc Touzard](https://github.com/LoicTouzard), [Paul Dautry](https://github.com/pdautry) et [Kévin Bulmé](https://github.com/KevinBulme).
Remerciements à [Lisa Courant](https://github.com/lisacourant) pour le logo.
35 changes: 0 additions & 35 deletions doc/cdc.md

This file was deleted.

0 comments on commit 8d20dc8

Please sign in to comment.