Giter Club home page Giter Club logo

riadhossain43 / formkiq-core Goto Github PK

View Code? Open in Web Editor NEW

This project forked from formkiq/formkiq-core

0.0 0.0 0.0 4.58 MB

FormKiQ Core is an Open Source Headless Document Management System (DMS) that runs in your Amazon Web Services (AWS) Cloud. Can be used for document workflows, records management, and other document storage and processing needs, using an extendable Document API.

Home Page: https://www.formkiq.com

License: Other

Shell 0.03% JavaScript 0.52% Python 0.07% Java 99.31% Dockerfile 0.07%

formkiq-core's Introduction

FormKiQ

FormKiQ Core   Tweet

License: MIT

Click Here for One-click Installation

Table of Contents

Table of Contents

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.

formkiq-core's People

Contributors

formkiqmike avatar mfriesen avatar reganwolfrom avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.