Updated Documentation
- Rewrote README.md - Added --help flag for script - server.json now uses 2-spaces-indentationpull/12/head
Trivernis
6 years ago
parent
48db477a27
commit
83a9f98bf0
@ -1,45 +1,93 @@
|
||||
rcn-frontserver <img src="https://raw.githubusercontent.com/Trivernis/rcn-frontserver/develop/res/img/RCN-Logo.png" height="100px" width="auto"></img>
|
||||
====
|
||||
This is the front-end web-server of the Raspberry Communication Network *(that is still in development)*.
|
||||
|
||||
About
|
||||
Contents
|
||||
----
|
||||
This is the front-web-server of the Raspberry pi Communication network.
|
||||
1. [Requirements](#requirements)
|
||||
2. [Getting Started](#getting-started)
|
||||
3. [Arguments](#arguments)
|
||||
4. [Configuration](#configuration)
|
||||
1. [Routes for each type of file](#routes-for-each-type-of-file)
|
||||
2. [Mounting external folders](#mounting-external-folders)
|
||||
5. [Cool Features](#cool-features)
|
||||
6. [Roadmap](#roadmap)
|
||||
|
||||
Modules
|
||||
Requirements
|
||||
----
|
||||
**NodeJS**
|
||||
- winston
|
||||
- pkg
|
||||
- perfy
|
||||
- jsdom
|
||||
- winston-daily-rotate-file
|
||||
- args-parser
|
||||
- node-sass
|
||||
|
||||
**Embedded in the html-file**
|
||||
- JQuery
|
||||
- Vue.js
|
||||
|
||||
Details
|
||||
You need to have Node.js installed to run this script. Just in case update your npm with the command:
|
||||
```commandline
|
||||
npm install -g npm@latest
|
||||
```
|
||||
|
||||
Getting started
|
||||
----
|
||||
To install the dependencies listed above, run the following from the commandline.
|
||||
```commandline
|
||||
npm install
|
||||
```
|
||||
Now you can run the server by typing:
|
||||
```commandline
|
||||
node server.js
|
||||
```
|
||||
|
||||
Arguments
|
||||
----
|
||||
Just type `node server.js -h` or
|
||||
```commandline
|
||||
Usage: server.js [options]
|
||||
|
||||
Options:
|
||||
-h, --help show this help message and exit
|
||||
-p, --port define the port for the server to run on
|
||||
--loglevel define at which level the console should output
|
||||
--test start the server and exit after 10 seconds
|
||||
```
|
||||
|
||||
Configuration
|
||||
----
|
||||
This web server uses folders for every type of file (depending on the file's ending) and routes to the folders. There are also global files, that are implemented in every html via dom-manipulation. The behaviour for every file extension can be configured in the config.json This server uses vue.js and jquery to make the website as interactive, as possible. This server works with https. To run it. it needs to have access to the folder .ssh in the same directory where a valid cert.pem and a valid key.pem is are existing. Specific directories can be mounted via the mounting parameter. The pattern is:
|
||||
``` json
|
||||
*This configuration applies to the server.json.*
|
||||
|
||||
### Routes for each type of file
|
||||
In the server.json all common web file-types have their own configuration at **routes**.
|
||||
```json
|
||||
{
|
||||
"routes": {
|
||||
".html": {
|
||||
"path": "./res/html/",
|
||||
"mime": "text/html"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
In the configuration a path and mime-type is defined. When the server starts recieves a request, it reads the configuration and searches for the file in the specific route. If the file exists it gets transportet with the defined mime-type. The type of the file is determined with the file's extension.
|
||||
|
||||
### Mounting external folders
|
||||
It is also possible to mount additional folders into the web-application by defining them at **mounts**. Mounts are more important than routes so when the server recieves a request, it first looks if the request-url has a mounted directory (or file).
|
||||
|
||||
```json
|
||||
{
|
||||
"mounts": [
|
||||
{
|
||||
"mount": "mountpath",
|
||||
"path": "path"
|
||||
"path": "./path/to/directory/",
|
||||
"mount": "/mount/"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
You can embed sass files as link elements in html-pages. The sass files will be preprocessed to css before send to clients. The result will also be cached and the sass file will be watched for changes. If changes occur, the file will be preprocessed anew on the next request to the file. If not, the cached file will be send. HTML-files will also be cached because they are also manipulated by the preprocessor. All cached files are watched for changes. I.e. if changes to the file are detected the caching function isCached returns false.
|
||||
```
|
||||
The path Attribute defines the mounted directory (of file) on the local filesystem. The mount attribute defines where the directory is mounted in the web-application. The mount-path supports RegEx strings (the value is interpreted as a regular Expression by default).
|
||||
|
||||
Cool features
|
||||
---
|
||||
### Embedding SASS-Stylesheets, Vue.js and jQuery
|
||||
This server automatically embeds Vue.js, jQuery and the *script.js* and *style.sass* stored in *./glob*. And yeah, that's right. You can embed .sass-files. When encountering a .sass file, the server compiles it into .css. The result will then be stored in the *./.cache* directory. The server also detects changes on the original file and refreshes the cached file when the change was detected. The refreshing only happens, when the file was requested.
|
||||
|
||||
Roadmap
|
||||
----
|
||||
**Done**
|
||||
- SASS-Files and caching of preprocessed files
|
||||
**ToDo**
|
||||
- Mounting of folders or files on other locations (by using the config.json)
|
||||
- a package.json because it seems to be important nowadays
|
||||
- [x] SASS-Files and caching of preprocessed files
|
||||
- [x] Mounting of folders or files on other locations (by using the config.json)
|
||||
- [x] A package.json because it seems to be important nowadays
|
||||
- [x] HTTP-Statuscode integration with specific pages
|
||||
- [ ] Handling POST-Methods
|
||||
- [ ] Integrating Backend-Applications via a standardized JSON-interface
|
||||
- [ ] Change from JSON to CSON and consider this in the standardized interface
|
||||
@ -1,48 +1,48 @@
|
||||
{
|
||||
"errors": {
|
||||
"403": "./glob/errors/403.html",
|
||||
"404": "./glob/errors/404.html"
|
||||
},
|
||||
"routes": {
|
||||
".html": {
|
||||
"path": "./res/html/",
|
||||
"mime": "text/html"
|
||||
},
|
||||
".htm": {
|
||||
"path": "./res/html/",
|
||||
"mime": "text/html"
|
||||
},
|
||||
".js": {
|
||||
"path": "./res/scripts/",
|
||||
"mime": "text/javascript"
|
||||
},
|
||||
".css": {
|
||||
"path": "./res/css/",
|
||||
"mime": "text/css"
|
||||
},
|
||||
".json": {
|
||||
"path": "./res/data/",
|
||||
"mime": "text/plain"
|
||||
},
|
||||
".ico": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/x-icon"
|
||||
},
|
||||
".jpg": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/jpeg"
|
||||
},
|
||||
".png": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/png"
|
||||
},
|
||||
".ttf": {
|
||||
"path": "./res/fonts/",
|
||||
"mime": "font/opentype"
|
||||
},
|
||||
".sass": {
|
||||
"path": "./res/sass",
|
||||
"mime": "style/css"
|
||||
}
|
||||
}
|
||||
"errors": {
|
||||
"403": "./glob/errors/403.html",
|
||||
"404": "./glob/errors/404.html"
|
||||
},
|
||||
"routes": {
|
||||
".html": {
|
||||
"path": "./res/html/",
|
||||
"mime": "text/html"
|
||||
},
|
||||
".htm": {
|
||||
"path": "./res/html/",
|
||||
"mime": "text/html"
|
||||
},
|
||||
".js": {
|
||||
"path": "./res/scripts/",
|
||||
"mime": "text/javascript"
|
||||
},
|
||||
".css": {
|
||||
"path": "./res/css/",
|
||||
"mime": "text/css"
|
||||
},
|
||||
".json": {
|
||||
"path": "./res/data/",
|
||||
"mime": "text/plain"
|
||||
},
|
||||
".ico": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/x-icon"
|
||||
},
|
||||
".jpg": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/jpeg"
|
||||
},
|
||||
".png": {
|
||||
"path": "./res/img/",
|
||||
"mime": "image/png"
|
||||
},
|
||||
".ttf": {
|
||||
"path": "./res/fonts/",
|
||||
"mime": "font/opentype"
|
||||
},
|
||||
".sass": {
|
||||
"path": "./res/sass",
|
||||
"mime": "style/css"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue