Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binarykitchen/videomail-for-ninja-forms

With this add-on recording videos in Wordpress Ninja Forms comes true.
https://github.com/binarykitchen/videomail-for-ninja-forms

audio extension ninjaforms video videomail wordpress

Last synced: 3 months ago
JSON representation

With this add-on recording videos in Wordpress Ninja Forms comes true.

Awesome Lists containing this project

README 

        
# Videomail for Ninja Forms (developer documentation)



[![Test Runner](https://github.com/binarykitchen/videomail-for-ninja-forms/actions/workflows/push.yml/badge.svg)](https://github.com/binarykitchen/videomail-for-ninja-forms/actions/workflows/push.yml)



Record videos in Ninja Forms!



> Finally you can encode any webcam recordings from modern browsers and mobiles into MP4 + WebM within seconds. This without the need for Flash, Java nor any other plugins / addons. Just JavaScript.



With this add-on recording videos in Wordpress forms comes true. No further coding required. Just install + configure a bit, that’s all.



More documentation, aimed at the mortal user, is in the readme.txt - this here is for developers only.



## Dependencies



Requires the [Ninja Forms plugin](https://github.com/wpninjas/ninja-forms).



In short: this add-on runs on the Ninja Forms plugin engine where you can configure forms very easily. Upon installation, a new type will be added to enable recordable videos.



## Development (Personal)



1. Install WordPress locally or use [Local by Flywheel](https://local.getflywheel.com/)

2. Log into Local and import Blueprint if any exist

3. Install Ninja Forms Plugin

4. `git clone [email protected]:binarykitchen/videomail-for-ninja-forms.git`

5. Symlink videomail-for-ninja-forms like that: `ln -s ~/code/binarykitchen/videomail-for-ninja-forms ~/Local\ Sites/videomail-for-ninja-forms/app/public/wp-content/plugins/videomail-for-ninja-forms`

6. Activate it on WP admin side

7. Install latest nodejs, best with [nvm](https://github.com/creationix/nvm)

8. `npm install` to install dependencies

9. `gulp watch --host x --port y` which will open Google Chrome and automatically reloads upon changes (PHP, JS and CSS). Defaults to https://localhost:8890



Note: depending on your OS the `gulp watch` command might result into errors;



### Arch Linux Issues



- Afraid have to amend `sudo` before `npm run mh` or so. <-------- !!!

- Can't use .local domain as it's [reserved under Arch Linux](https://community.localwp.com/t/local-tld-is-not-resolved-when-in-hosts-file-if-used-on-arch-based-linux/43793/6)



### Customize host or port



For custom hosts or ports, you can customize `gulp watch` like that:



`gulp watch --port=8890 --host=wp` and that will open this page for you:

https://wp:8890/wordpress/wp-admin/admin.php?page=ninja-forms



(for exactly these parameters, there is a short cut: `npm run wp` and `wp:8890` is already whitelisted)



## Directory structure



In `src` you do the normal development work. When gulp watches for changes, they get recompiled into the `target` folder and will be served from there.



This is needed so that this repository can be used right away as a plugin folder without the need to run any other commands. This is a requirement for automatic Ninja Forms plugin releases.



In `dist` you can find a latest version in a zip file for easier distribution. Can be useful sometimes. `env` contains code depending on environment, such as bash scripts for building releases.



## Examples



In the `/examples` folder you can see some ready-to-import Ninja Forms templates and HTML examples for re-use. They might inspire you …



## Documentation



In the `/doc` folder we place in all text and images for the public documentation.



## Report bugs



https://github.com/binarykitchen/videomail-for-ninja-forms/issues



## Releasing



1. Ensure you are on develop branch

2. Update changelog in readme.txt (stable tag + changelog)

3. Search for current version and replace it with the new one. Should be these files:

   - package.json

   - readme.txt

   - videomail-for-ninja-forms.php

   - src/php/videomail.php

4. Optional: validate readme.txt with https://wordpress.org/plugins/developers/readme-validator/

5. Run `npm run clean`, `npm install` and `npm run build`

6. Git commit and push

7. Run `npm run release`

8. Tag a new release which will run the release workflow on GitHub, e.g. with `gh release create`

   (upon any errors, you may try to run manually "gh release create" again to trigger a release on GitHub)

9. Announce on Twitter



## Ask for help



https://binarykitchen.com