https://github.com/abumq/ejs-preview
Preview EJS template by providing JSON data
https://github.com/abumq/ejs-preview
ejs-express ejs-templates node-development
Last synced: about 1 year ago
JSON representation
Preview EJS template by providing JSON data
- Host: GitHub
- URL: https://github.com/abumq/ejs-preview
- Owner: abumq
- License: other
- Created: 2020-01-04T04:26:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T19:16:21.000Z (over 3 years ago)
- Last Synced: 2025-02-01T10:27:42.504Z (over 1 year ago)
- Topics: ejs-express, ejs-templates, node-development
- Language: JavaScript
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EJS Preview
Preview EJS template by providing JSON data
• • •
• • •
## Installation
```bash
npm i ejs-preview -S
```
```bash
yarn add ejs-preview
```
```
ejs-preview --root=/path/to/root/files --common=/json/file.json
```
* `root`: Path to the root files. e.g, `/app/src/templates`
* `common`: Path to JSON file. Common data for all the templates. e.g, `/app/src/templates/preview-common.json`
Once server is running you can pass following query parameters
* `template`: EJS file base to render (relative to root) e.g, `?template=emails/welcome` will render `/emails/welcome.ejs`.
The template specific data is picked up from `/emails/welcome.preview.js` which should look like:
```
module.exports = {
activationLink: '/link',
};
```
* `common` If you want to override `common` args provided at the startup
* `plain` If specified `plain/text` content-type is sent
You can change the port with `PORT` environment variable
# License
```
Copyright (c) 2020 Amrayn Web Services
Copyright (c) 2020 @abumusamq
https://github.com/amrayn/
https://amrayn.com
https://humble.js.org
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```