npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@digital-blueprint/formalize-app

v1.1.0

Published

[GitHub Repository](https://github.com/digital-blueprint/formalize-app) | [npmjs package](https://www.npmjs.com/package/@digital-blueprint/formalize-app) | [Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/formalize-app/) | [Formalize Bundle](https:

Downloads

463

Readme

Formalize Application

GitHub Repository | npmjs package | Unpkg CDN | Formalize Bundle

Build, Test and Publish

Management of form entries that have been created via external systems.

Prerequisites

Local development

# get the source
git clone [email protected]:digital-blueprint/formalize-app.git
cd formalize-app
git submodule update --init

# install dependencies
npm install

# constantly build dist/bundle.js and run a local web-server on port 8001 
npm run watch

# constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_local/
npm run watch-local

# run tests
npm test

Jump to https://localhost:8001, and you should get a Single Sign On login page.

Using this app as pre-built package

Install app

If you want to install the dbp formalize app in a new folder formalize-app you can call:

npx @digital-blueprint/cli install-app formalize formalize-app /

Warning: There may be issues when you run these commands as root user, best use a non-root user, like www-data. To do this you can for example open a shell with runuser -u www-data -- bash.

Afterwards you can point your Apache web-server to formalize-app/public.

Make sure you are allowing .htaccess files in your Apache configuration.

Also make sure to add all of your resources you are using (like your API and Keycloak servers) to the Content-Security-Policy in your formalize-app/public/.htaccess, so the browser allows access to those sites.

You can also use this app directly from the Unpkg CDN for example like this: dbp-formalize/index.html

Note that you will need a Keycloak server along with a client id for the domain you are running this html on.

Update app

If you want to update the dbp formalize app in the current folder you can call:

npx @digital-blueprint/cli update-app formalize

Warning: There may be issues when you run these commands as root user, best use a non-root user, like www-data. To do this you can for example open a shell with runuser -u www-data -- bash.

Activities

This app has the following activity:

  • dbp-show-registrations

You can find the documentation of the activity in the formalize activities documentation.

Adapt app

Functionality

You can add multiple attributes to the <dbp-formalize> tag.

| attribute name | value | description | |----------------|-------| ------------| | provider-root | Boolean | app-shell | | lang | String | language-select | | entry-point-url | String | app-shell | | keycloak-config | Object | app-shell | | base-path | String | app-shell | | src | String | app-shell | | html-overrides | String | common | | themes | Array | theme-switcher | | darkModeThemeOverride | String | theme-switcher |

Mandatory attributes

If you are not using the provider-root attribute to "terminate" all provider attributes you need to manually add these attributes so that the topic will work properly:

<dbp-formalize
    auth
    requested-login-status
    analytics-event
>
</dbp-formalize>

Design

For frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the theming documentation.

"dbp-formalize" slots

These are common slots for the app-shell. You can find the documentation of these slots in the app-shell documentation. For the app specific slots take a look at the formalize activities.

Notice

We are using autogenerated table header for creating the submission tables.

A get query is made to dbp-relay. This returns a json. This json contains various data of the previous posted submission.

To post a form to the api, take a look at: operations-Formalize-postFormalizeSubmissionCollection. This post contains the name of the form "form" and the data of the form "dataFeedElement". the data must be a valid json as a string, i.e. quotation marks must be escaped with a "". The data keys of forms with the same "form" name must be consistent, otherwise the new keys are not displayed and no data would be displayed in the old key table header.