Menu

Tree [1ca61f] master /
 History

HTTPS access


File Date Author Commit
 .github 2022-08-29 Mike Friesen Mike Friesen [1ac7fa] v1.8.4 (#33)
 .settings 2022-08-25 Mike Friesen Mike Friesen [2203e3] v1.8.3 (#32)
 actions 2022-10-23 Mike Friesen Mike Friesen [cc9cc5] Dev (#65)
 aws-cognito 2022-08-25 Mike Friesen Mike Friesen [2203e3] v1.8.3 (#32)
 aws-dynamodb 2022-10-19 Mike Friesen Mike Friesen [397b7e] #60 - PATCH /documents/{documentId} does not su...
 aws-iam 2022-08-25 Mike Friesen Mike Friesen [2203e3] v1.8.3 (#32)
 aws-lambda 2022-08-25 Mike Friesen Mike Friesen [2203e3] v1.8.3 (#32)
 aws-s3 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 aws-sns 2022-09-18 Mike Friesen Mike Friesen [909a8e] v1.8.7 (#42)
 aws-sqs 2022-09-18 Mike Friesen Mike Friesen [909a8e] v1.8.7 (#42)
 aws-ssm 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 aws-sts 2022-08-25 Mike Friesen Mike Friesen [2203e3] v1.8.3 (#32)
 config 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 console 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 document-events 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 dynamodb-documents 2022-10-23 Mike Friesen Mike Friesen [cc9cc5] Dev (#65)
 fkq-lambda-core 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 fkq-lambda-services 2022-09-18 Mike Friesen Mike Friesen [909a8e] v1.8.7 (#42)
 fkq-plugins 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 fkq-test-utils 2022-10-23 Mike Friesen Mike Friesen [cc9cc5] Dev (#65)
 fkq-validation 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 gradle 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 lambda-api 2022-10-24 Mike Friesen Mike Friesen [cc4f0d] PUT /documents/{documentId}/fulltext - added su...
 lambda-s3 2022-10-24 Mike Friesen Mike Friesen [1ca61f] DocumentActions - added filtering only USERDEFI...
 module-email-notify 2022-09-18 Mike Friesen Mike Friesen [909a8e] v1.8.7 (#42)
 src 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 websocket-api 2022-10-23 Mike Friesen Mike Friesen [cc9cc5] Dev (#65)
 .classpath 2020-12-21 Mike Friesen Mike Friesen [df7750] V1.1.0 (#3)
 .gitignore 2022-04-19 Mike Friesen Mike Friesen [d70257] V1.6.0 (#16)
 .project 2020-12-21 Mike Friesen Mike Friesen [df7750] V1.1.0 (#3)
 CHANGELOG.md 2021-02-13 Mike Friesen Mike Friesen [76f90c] Update CHANGELOG.md
 INSTALL.md 2021-01-07 Regan Wolfrom Regan Wolfrom [990317] tweaks to INSTALL text
 LICENSE 2020-11-21 Mike Friesen Mike Friesen [bedc50] Updated License to MIT
 README.md 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 SAM-CLI-with-FormKiQ-Document-Event.png 2021-01-29 Regan Wolfrom Regan Wolfrom [aa741f] added image for plugin wiki entry
 architecture.svg 2020-12-22 Mike Friesen Mike Friesen [1a2a63] Updated Readme (#4)
 build.gradle 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 docker-compose-dynamodb.yml 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 docker-compose.yml 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 emptyVersionedBucket.py 2020-12-21 Mike Friesen Mike Friesen [df7750] V1.1.0 (#3)
 fq-gh-social.png 2022-05-18 Regan Wolfrom Regan Wolfrom [6d186c] added GH social PNG
 gradle.properties 2022-05-23 Mike Friesen Mike Friesen [ba4e00] v1.7.0 release (#19)
 gradlew 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 gradlew.bat 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 install-play.png 2022-08-14 Mike Friesen Mike Friesen [3b64a2] Add files via upload
 logo.png 2020-11-22 Regan Wolfrom Regan Wolfrom [c79c93] logo tweak
 openapi-iam.yaml 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 openapi-jwt.yaml 2022-10-16 Mike Friesen Mike Friesen [5f2e9f] v1.8.9 (#58)
 settings.gradle 2022-09-25 Mike Friesen Mike Friesen [72a54d] v1.8.8 (#49)
 spotless.eclipseformat.xml 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 wait-for-dynamodb.sh 2020-11-21 Mike Friesen Mike Friesen [466aee] Initial Commit (#1)
 wait-for-localstack.sh 2022-05-02 Mike Friesen Mike Friesen [229e6c] added gradle org.gradle.parallel support (#18)

Read Me

FormKiQ

FormKiQ Core   Tweet

License: MIT

Click Here for One-click Installation

Table of Contents

Table of Contents - [What is FormKiQ Core](#what-is-formkiq-core) - [Installation](#installation) - [Architecture](#architecture) - [Documentation](#documentation) - [Client Libraries](#client-libraries) - [Use Cases](#use-cases) - [Application Examples](#examples) - [Building from source](#building-from-source) - [License](#license)

What is FormKiQ Core?

FormKiQ Core is an Open Source Headless Document Management System (DMS) that runs completely in YOUR Amazon Web Services (AWS) Cloud.

You can use FormKiQ Core to power:
* Easily store Documents / Form data from your website
* Quickly Tag and Organize your Documents
* Flexible integrate into existing application or build custom workflows

FormKiQ Core is built for any size organization, from personal websites to large, enterprise organizations requiring full control of any number of internal and external documents.

FormKiQ Core is built using AWS Serverless services like AWS Lambda, Amazon API Gateway, Amazon DynamoDB and Amazon S3; this means that there are no servers for you to maintain or manage, and all of your data stays within your AWS cloud.

Features

Please visit our website to see the full list of features.

✅ API First (FormKiQ API) and Cloud-Native Architecture

✅ Easy Integration with Existing Applications

✅ Built Using Serverless Services (no servers to maintain or manage)

✅ Supports Unlimited Document Tagging & Versioning

✅ Document Processing Through Subscribing to Document Events

✅ Supports Both Multi-Tenant and Multi-Instance

✅ Includes an Intuitive User Interface (FormKiQ Console) for Document Management

Installation

The following are AWS CloudFormation scripts that can be used to install FormKiQ and other resources in a single click!

Full Installation Instructions

AWS Region Install Link
us-east-1 Install FormKiQ Core in US-EAST-1 region
us-east-2 Install FormKiQ Core in US-EAST-2 region
ca-central-1 Install FormKiQ Core in CA-CENTRAL-1 region
eu-central-1 Install FormKiQ Core in EU-CENTRAL-1 region

Architecture

Architecture Diagram

FormKiQ Core has been architected using Amazon Web Services (AWS) Serverless technologies. This provides several benefits:

✅ Only pay AWS for usage (all services come with a generous monthly free tier)

✅ Easily scales to thousands of concurrent requests

✅ No servers to maintain or manage

Documentation

Full FormKiQ Documentation can be found at

https://docs.formkiq.com/

List of AWS Services

FormKiQ core uses the following AWS technologies:

  • Amazon S3 - for storage of files / documents
  • Amazon CloudFront - for hosting the FormKiQ Console
  • AWS Lambda - for document processing
  • Amazon DynamoDB - storing of document metadata
  • API Gateway - to serve the RESTful API platform
  • Amazon Simple Notification Service (SNS) - document status notify system, allows applications to be notified that a document has been create/deleted or updated
  • AWS IAM and Amazon Cognito - User and System authentication

How much does it cost to run

FormKiQ Core was created using serverless technology. This means that there are no servers to manage; everything is managed by AWS. All AWS services FormKiQ uses pay-per-usage billing. You can start using FormKiQ with very little cost.
AWS provides a free tier to all AWS accounts. This means that some AWS services you can use for free pending you stay under the usage limits. Below is the list of services FormKiQ uses and their approximate usage costs, so give you an idea on how much it costs to run FormKiQ. (All costs in USD)
| Service | Cost |
| ------------- | -----|
| Amazon Api Gateway | $1.00 per million requests
| Amazon DynamoDB | First 25 GB Free |
| |Write request units - $1.25 per million write request units |
| |Read request units $0.25 per million read request units |
| Amazon CloudFront | $0.085 per GB of Data Transfer Out to Internet||
| Amazon S3 | $0.023 per GB / Month|
| AWS Lambda | approx. first 400,000 requests Free per Month|
| |$0.0000168667 per additional request

Client Libraries

Client libraries

Language Client
Java formkiq-client-sdk-java

Use Cases

Examples

FormKiQ core can be used immediately after being deployed to handle web form submissions on your website. (In fact, you don't even need to be hosting your site in AWS to use FormKiQ for processing your site visitor's form submissions.)

The easiest way to include FormKiQ on your website is through the FormKiQ Client SDK npm module.

You can see FormKiQ Core and the FormKiQ Client SDK in action in the examples below:

Web Form Example - Contact Form

https://github.com/formkiq/formkiq-webform-examples-contact

Screenshot of Contact Form Example

Web Form Example - Job Application Form

https://github.com/formkiq/formkiq-webform-examples-jobapplication

Screenshot of Job Application Form Example

Building from source

Please see our docs for instructions.

License

MIT - 2020-2022 (c) FormKiQ, Inc. For more details, see LICENSE file.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.