panachemidi/terra-arcana
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Terra Arcana - Grandeur Nature médiéval fantastique http://terraarcana.com
445 commits 893 branches 11 tags 1.7 MiB
Find a file
Exact
Frédéric Bolduc acafff07d8 Add character class to character sheets 
wip #8
2017-06-03 13:53:29 -04:00
acf-json Add missing ACF group 2017-04-13 23:00:30 -04:00
app Add character class to character sheets 2017-06-03 13:53:29 -04:00
hosting Added directives to php.ini file 2016-04-28 15:38:59 -04:00
src Update primary class in real time in character builder 2017-06-03 00:44:53 -04:00
.eslintrc * Upgrade to React 15 2016-09-02 09:09:05 -04:00
.gitignore Add ignore clause for vscode files 2017-05-18 08:05:21 -04:00
AUTHORS.md Update AUTHORS.md 2016-04-19 12:09:29 -04:00
composer.json Switched TGM submodule to a composer package 2015-12-04 21:31:47 -05:00
composer.lock Switched TGM submodule to a composer package 2015-12-04 21:31:47 -05:00
dockerfile Added directives to php.ini file 2016-04-28 15:38:59 -04:00
entrypoint.sh Removed comments 2016-04-07 23:16:51 -04:00
esdoc.json Admin mode scaffolding 2016-01-23 03:15:46 -05:00
favicon.ico Added favicon and HTML title 2016-05-03 00:42:10 -04:00
functions.php Save new XP values to database 2017-01-25 00:04:05 -05:00
index.php Footer 2016-12-05 22:58:55 -05:00
karma.conf.js Switched require calls to es6 imports in tests 2016-11-25 08:43:04 -05:00
LICENSE Added GPL v3 license 2016-01-27 17:45:10 -05:00
package.json Prepare 1.0.2 release 2017-05-31 22:40:55 -04:00
provision.sh Working Vagrant box 2016-06-08 23:18:33 -04:00
README.md Update README.md 2016-04-07 23:14:27 -04:00
style.css Complete wordpress theme metadata 2016-08-31 08:18:17 -04:00
Vagrantfile Working Vagrant box 2016-06-08 23:18:33 -04:00
webpack.config.js Admin XP stub 2017-01-13 13:57:56 -05:00
webpack.tests.js Fixed errors on missing WP_API_Settings on unit tests 2016-04-07 21:22:40 -04:00

README.md

Staging - Build Status

Terra Arcana

http://www.terraarcana.com

Bienvenue au futur du site web du GN Terra Arcana! Le site refera prochainement peau neuve, avec un nouveau thème WordPress supportant des technologies modernes telles que WP REST API, ReactJS et Konva.

Avec celle nouvelle approche, nous nous tournons vers GitHub et la communauté open-source québécoise, pour faire de Terra Arcana le leader en site de GN au Québec.

Installation

  1. Téléchargez WordPress sur votre poste. Une installation vierge est suggérée.

  2. Suivez la procédure d'installation de WordPress pour vous créer un compte administrateur et générer une base de données MySQL.

  3. Si votre installation d'Apache est manuelle (c'est-à-dire pas WAMP, MAMP, XAMPP, ou etc):

  • Assurez-vous dans votre fichier httpd.conf que AllowOverride est bien configuré à All et non à None pour votre dossier qui vous sert de racine web (normalement htdocs ou /var/www)

  1. Clonez le repositoire de Terra Arcana dans le dossier wp-content/themes/ de votre installation WordPress.

  2. Exécutez les commandes suivantes pour installer toutes les dépendances du projet (installez préalablement NPM et Composer si ce n'est pas déjà fait):

npm install             // Installe toutes les dépendances JavaScript dans /node_modules
npm install -g webpack  // Installe webpack globalement (nécessaire pour générer les fichiers HTML/CSS/JS distribués)
npm install -g esdoc    // Installe esdoc globalement (nécessaire pour générer la documentation)
composer install        // Installe toutes les dépendances PHP dans /vendor
webpack                 // Génère une première fois les fichiers distribués dans /dist et la documentation dans /docs
  1. Connectez-vous dans le panneau d'administration de WordPress (à {votre URL local}/wp-admin) et rendez-vous dans Apparence dans le menu de gauche pour activer le thème Terra Arcana.

Développement

Le thème utilise webpack pour transpiler les fichiers sources en fichiers distribués, ainsi que générer la documentation du projet. Lancez webpack --progress -w dans un terminal séparé pour que vos changements régénèrent automatiquement à la sauvegarde les fichiers distribués.

Le projet utilise également ESLint pour vérifier la syntaxe des fichiers sources, et est lancé par webpack à chaque sauvegarde. Assurez-vous que votre code passe tous les tests de syntaxe avant de soumettre vos commits.

La documentation du projet est générée par ESDoc, et est disponible dans le dossier docs de votre projet une fois webpack exécuté au moins une fois. Consultez la documentation pour la liste des tags disponibles.

Arborescence

  • src
    Tout le back-end PHP du thème. Le point d'entrée officiel de WordPress étant functions.php, celui-ci ne sert qu'à charger la classe mère de l'application, située à src/controllers/main-controller.class.php.

  • app
    Tout le front-end Javascript/JSX. Les points d'entrée sont app/app.js et app/index.html.

  • acf-json
    Fichiers JSON générés par ACF Pro représentant les modèles de données des types de contenu créés par le thème. Ne pas toucher directement.