The purpose of this repository is to provide a Form Server for testing and developing Winlink Forms.
This is a placeholder, more information will be added in the near future.
- Clone this repository and change to the clone directory root.
- If using Windows, install WSL and select a Linux distribution of your preference (at the time of this writing, I'd recommend Ubuntu 22.04). Open a WSL shell before continuing.
- In Linux (or WSL) update packages using
sudo apt update
etc. - Install NVM (Node Version Manager) from nvm-sh on github. Use WGET or CURL as directed.
- Use NVM to install latest Node version:
nvm install node
. - Verify node and NPM installation with
node --version
andnpm --version
accordingly. Fix any issues before continuing. - Install dependencies using
npm install
.
- Copy your Winlink Template and Form file(s) to the
public/views
directory. - Copy
.env.example
and update the variables with your requirements. - Execute
npm run devStart
to start the server. - If running in VSCode, a prompt will ask you to open a Browser. Otherwise, maually open a browser and point to
https://{FORM_SERVER_HOSTNAME}:{API_PORT}
and the Winlink Form should be served. - Fill out the Form and click the Submit button.
- Review the Terminal output to see the JSON representation of the data the Form is configured to send.
- By design
.gitignore
will not allow checking in your ENV file, nor any Winlink Form file(s) to copy-in topublic/views
.