gowebframework/README.md

34 lines
1.4 KiB
Markdown
Raw Normal View History

2018-07-14 10:34:52 +00:00
# gowebframework
2018-07-14 10:58:25 +00:00
Petit framework web en go pour des petites applications avec chargement des templates et serveur intégré
Le framework se charche de servir les fichiers statiques (url: /static/) et, en mode debug, recharge automatiquement les templates.
2018-07-14 11:19:06 +00:00
Le fichier de configuration est passé dans `Configure()` et doit être au format json avec les paramètres suivants :
2018-07-14 10:58:25 +00:00
```json
{
"StaticFolderPath": "statics/",
"TemplateIncludePath": "templates/",
"TemplateLayoutPath": "templates/layouts/",
"TemplateExtensionPattern": "*.gohtml",
"ServerPort": ":8000",
"Domain": "http://git.an",
"MainTemplate": "{{define \"main\" }} {{ template \"base\" . }} {{ end }}",
2018-07-17 22:00:51 +00:00
"Debug": false,
"SessionProvider": "FileProvider"
2018-07-14 10:58:25 +00:00
}
```
2018-07-17 22:00:51 +00:00
Des paramètres par défaut sont utilisé dans tous les cas.
Le système de session utilise un dossier `.session` généré automatiquement, attention aux permissions !
Il est possible de rajouter ses propres backend pour le système de session en les enregistrant grâce à la fonction `SessionProviderRegister`. Les backends doivent respecter l'interface `SessionProvider`.
2018-07-14 10:58:25 +00:00
Le MainTemplate est utilisé pour charger tous les templates, il peut être utilisé tel quel ou modifié si vous savez ce que fous faites. Dans le doute, laissez celui par défaut.
2018-07-14 11:02:12 +00:00
2018-07-14 11:19:06 +00:00
On lance enfin le serveur en utilisant `Start()`
Pour charger un template, il faut utiliser `RenderTemplate()`