README.md 2.4 KB
Newer Older
1 2
# DTY Board Game Toolbox

DarthGege's avatar
DarthGege committed
3 4 5 6 7 8 9 10 11 12 13 14
### Sommaire

1. [Principe](#introduction)
2. [Liste des outils](#outils)
3. [Installation](#installation)
4. [Utilisation](#utilisation)
5. [Remarques](#remarques)
6. [TODO](#todo)


### 1. Principe <a name="introduction"></a>

15 16
L'objectif était de créer une application permettant de mettre à disposition des joueurs un certain nombre d'outils pour les jeux de sociétés. L’application a pour but de rendre accessible et numérique les accessoires nécessaires pour jouer à des jeux de société, tant pour les joueurs classiques que pour les joueurs par internet et d’en ajouter d’autre. Cela se sous la forme d’une page personnelle sur laquelle on peut ajouter des rubriques et en supprimer.
Ce projet est composé d'un backend utilisant le framework express, d'un front avec framework7, d'une BDD SQLite3
DarthGege's avatar
DarthGege committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

### 2. Liste des outils <a name="outils"></a>

* Une note (simple zone de texte)
* Un dé paramétrable (nombre de faces, nombre de dés)
* Un compteur paramétrable

todo:
* Une liste à cocher
* Un chronomètre paramétrable (temps)
* Un minuteur paramétrable (temps)
* Une image
* Un tableau modifiable


### 3. Installation <a name="installation"></a>

Lancer depuis un terminal dans le dossier souhaité les commandes suivantes :
```
npm init
npm install express
npm install sqlite3
npm install framework7
git clone https://github.com/framework7io/framework7-template-single-view my-board-game-toolbox
cd ./my-board-game-toolbox
npm install
```

Remplacer le dossier www par celui présent sur ce git ainsi que le fichier index.js
Ajouter la base de données board_game_toolbox.db présent sur ce git

```
node index.js
```


### 4. Utilisation <a name="utilisation"></a>

Lancer depuis un terminal dans le dossier my-board-game-toolbox la commande suivante :
```
node index.js
```

A l'adresse `localhost`, le site affiche les rubriques contenu dans la base de données.

### 5. Remarques <a name="remarques"></a>

64 65
Je n'ai malheureusement pas eu le temps de réaliser tous les objectifs que je m'étais fixés, principalement par manque de temps.
La conversion en APK avec cordova ne présente pas de problématique technique grace à l'utilisation d'express et framework7, je n'ai cependant pas eu le temps de convertir mon application
DarthGege's avatar
DarthGege committed
66 67 68

### 6. TODO <a name="todo"></a>

69 70 71
* Pouvoir supprimer des rubriques via l'interface
* Ajouter une gestion des pages de rubriques
* Ajouter un système de connexion