Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b4rtaz/t3mpl-server
Server for T3MPL Editor.
https://github.com/b4rtaz/t3mpl-server
nodejs nodejs-server server static-site-generator t3mpl
Last synced: 14 days ago
JSON representation
Server for T3MPL Editor.
- Host: GitHub
- URL: https://github.com/b4rtaz/t3mpl-server
- Owner: b4rtaz
- License: mit
- Created: 2020-11-13T15:43:18.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-15T20:40:30.000Z (about 3 years ago)
- Last Synced: 2024-12-22T05:13:00.676Z (25 days ago)
- Topics: nodejs, nodejs-server, server, static-site-generator, t3mpl
- Language: TypeScript
- Homepage:
- Size: 104 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# T3MPL Server
[](https://app.travis-ci.com/github/b4rtaz/t3mpl-server) [](https://coveralls.io/github/b4rtaz/t3mpl-server?branch=master) [](/LICENSE) [](https://twitter.com/b4rtaz)
This is the server for [T3MPL Editor](https://github.com/b4rtaz/t3mpl-editor). You can forget about .zip/.t3data/.t3mpl files. You may update your site directly from the editor.
## 🔨 How to Build
[Node.js](https://nodejs.org/en/) is required. Clone this repository.
`git clone https://github.com/b4rtaz/t3mpl-server.git`
Run `scripts/install.sh`:
`bash scripts/install.sh`
## ⚡ How to Run
You need to build the server. The instruction is above. To start server, execute:
`npm run serve`
## ⚙️ Configuration
The server uses `configuration.json` file. This file will be created when you run `scripts/install.sh`. The server supports only that method for now.
#### Session
This project uses [cookie session](https://github.com/expressjs/cookie-session#readme). This middleware does not require any database, but it requires secret keys to validate session cookies. **It is very important to set custom keys for each instance of server.**
```json
"session": {
"secretKeys": [
"",
"",
""
],
"maxAge": 43200000
}
```
You can use `scripts/random-session-keys.js` to generate new keys.
`node scripts/random-session-keys.js configuration.json`
#### Users
The server support many users.
* `name` - user name,
* `hashedPassword` - hashed password by SHA256, you may use [this tool](https://emn178.github.io/online-tools/sha256.html) for that.
```json
"users": [
{
"name": "",
"hashedPassword": ""
}
]
```
The default configuration contains the `admin` user with the `admin` password.
#### Websites
Each user can have many websites.
* `name` - display name,
* `owner` - user name of owner,
* `templateDirPath` - relative or absolute path to template directory, in this directory should be `template.yaml` file,
* `dataDirPath` - relative or absolute path to data directory, in this directory should be `data.json` file,
* `releaseDirPath` - relative or absolute path to release directory, the generator generates final website here.
* `keepReleaseFiles` - the generator cleans the release dir before upload a new version, you can specify which files/directories should be kept in. This field doesn't support subdirectories.
The server **must have** access to read/write provides directories.
```json
"websites": [
{
"name": "boilerplate",
"owner": "admin",
"templateDirPath": "./websites/boilerplate/template",
"dataDirPath": "./websites/boilerplate/data",
"releaseDirPath": "./websites/boilerplate/release",
"keepReleaseFiles": [".gitignore", "dirname"]
}
]
```
## 💡 License
This project is released under the MIT license.