https://github.com/gromnitsky/spartaforms

A tiny framework for making one-page surveys. Minimum dependencies.
https://github.com/gromnitsky/spartaforms

Last synced: 6 months ago
JSON representation

A tiny framework for making one-page surveys. Minimum dependencies.

• Host: GitHub
• URL: https://github.com/gromnitsky/spartaforms
• Owner: gromnitsky
• Created: 2025-01-28T14:15:17.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2025-02-11T14:41:00.000Z (8 months ago)
• Last Synced: 2025-02-17T20:57:30.896Z (8 months ago)
• Language: JavaScript
• Homepage: https://apps.sigwait.org/spartaforms/js101/
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
How it works:

1. `server.js` contains a static web server.

    Usage: `server.js public_dir db_dir`

2. When it gets `/foo/` request from a browser, it expects to find

   `$public_dir/foo/index.html` file which should be a survey page, and

   *foo* is the name of the survey.

3. It sets cookies for `index.html` to differentiate between users

   later on. Nothing is saved on the server yet.

4. A user fills the form & hits Submit button.

5. The POST request also goes to `/foo/index.html`.

6. The server generates a JSON Schema from `index.html` (on the fly)

   to check the validity of the POST request.

7. The results are saved in `$db_dir` directory the JSON format.

8. The user can edit the survey within 5m of the last post.

9. `$db_dir` will contain not only the survey results, but symlinks

   to all the files from `$public_dir/foo/` directory. If you open

   `index.html` (under any static web server) it'll fill the form with

   the survey results.

## Usage

Node v22+.

1. Clone the repo.

2. `npm i`.

3. Run: `SECRET=12345 ./server.js --no-expiration public_html db`

4. Open http://127.0.0.1:3000/js101 in the browser.

## How to create a survey

1. `cp -a public_html/js101 public_html/my-survey`.

2. Edit `public_html/my-survey/index.html`.

To make the survey expire automatically, set the date of `index.html`

file *in the future* (`touch -d XXXX-XX-XX

public_html/my-survey/index.html`) and remove `--no-expiration` flag

when invoking `server.js`.

## server.js options

* `--no-expiration`: don't check mtime of `index.html` files.

* `--max-edits INT`: max allowed survey edits (default is 5, a

  non-number means ∞).

* `--max-payload BYTES`: max POST size (default is 5120).

Env vars:

* `HOST`

* `PORT`

* `SECRET`: used in making a signature for a cookie.

## ♲ Loicense

MIT