e59-website/README.md
2024-03-15 15:04:10 +01:00

78 lines
1.8 KiB
Markdown
Executable File

# e59.fr
Le site officiel du club réseaux disponible à l'adresse https://e59.fr/
```sudo apt-get install php7.4-gd```
# PHP Informations
## Pages
- ```about/``` Informations about the data usage of the platform
- ```account/``` Change public account informations
- ```admin/``` Admin panel
- ```assets/``` Banner, PP and Miniatures images
- ```editor/``` Articles markdown editor
- ```login/``` Login, register and logout page
- ```news/``` Articles explorer and viewer
- ```settings/``` Account settings
- ```src/``` Ressources for the website (images, css, fonts)
- ```upload/``` Uplaod an article
- ```users/``` Check user public account
## Code conventions
- PHP Variables format : ```$phpVariable```
- tables columns format : ```table_column```
- HTML Class format : ```html-class```
## $_SESSION[]
- ```userID```
- ```userName```
- ```userDisplayName```
- ```userLevel```
- ```userAccreditation```
## Global Variables
- ```$rootPageURL```
- ```$rootFilePath```
- ```$sqlDatabaseName```
- ```$sqlDatabaseUser```
- ```$sqldatabasePass```
- ```$sqlDatabaseHost```
- ```$pageTitle```
- ```$headerTitle```
- ```$headerSubtitle```
- ```$footerText```
- ```$confidentialLevels```
- ```$userLevels```
- ```$badges```
- ```$darkThemes```
- ```$lightThemes```
## Global Functions
- ```markdownContent($filePath, $rootFilePath)```
- ```fillHead($rootPageURL, $pageTitle, $darkTheme, $lightTheme)```
- ```fillHeader($rootPageURL, $headerTitle, $headerSubtitle)```
- ```fillNav($rootPageURL)```
- ```fillFooter($footerText)```
- ```sqlConnect($dbHost, $dbName, $dbUser, $dbPass)```
- ```userWidget($userPPURL, $userDisplayName, $userName, $userLevel, $badges)```
- ```listArticles($result, $rootPageURL)```
- ```textInput($type, $shapePath, $name, $placeholder, $value)```
- ```fileInput($name)```
- ```selectInput($name, $label, $options, $defaultValue)```