🤔 Sometimes it happens that you need to make a FAQ for closed purposes, but you don’t want to install docker or set up a server with a database.
🖤 Try it out: Faqelize Demo with password: 1234

Features

• Fully standalone solution
• No need hosting (can be used with pages at GitHub)
• Database encryption (AES-256)
• Easy to setup without coding
• Change logotype
• Create i18n (2 preinstalled languages: English and Russian)
• Database file can be hosted on dedicated bucket/server
• PWA support
• Flexible: database, password and logotype can be passed as URL parameters

How to run

• Download this project
• Run npm install
• Create file ./public/database.json with your Q/A database
• Run npm run serve
• Go to http://localhost:8080/ and check the FAQ (serve runs without password)

How to build

• Check encryptDatabase (in faqelize.config.js) parameter to define password encryption before building
• Run npm run build
• (optional) if encryptDatabase is true you need enter password to encrypt database
• Your FAQ is ready to use in ./docs folder 🎉

Database format

Simple JSON database with questions and answers.

[
    {
        "id": 1,
        "q": "What is your name?",
        "a": "My name is Ilya."
    }
]

Database with pages

[
    {
        "id": 2,
        "q": "What is JSON dictionary?",
        "a": {
            "type": "page",
            "page": "JSON_dict",
            "subText": "All about Dictionaries for Faqelize."
        }
    }
]

• page option is a name of component at ./src/pages/

Database with simple answers as html

[
    {
        "id": 3,
        "q": "What is HTML?",
        "a": {
            "type": "html",
            "html": "<h1>HTML</h1><p>HTML is a markup language used to create web pages.</p>"
        }
    }
]

Files to setup

• ./faqelize.config.js
• ./src/i18n/{language_code}.js
• ./public/database.json