README.md

FAQ Zenika

Internal Knowledge Database for your organization - https://demo.faq.team

✨ Interested in having a hosted version of the FAQ for your organization? Contact us!

What is FAQ?

FAQ is an internal knowledge database for your organization's members. It aims to be the "single source of truth" for most of your company-oriented information: "How does the variable part of the salary work?", "Can the client ask me to stay late at work?", ...

Philosophy

• Single source of truth: Regrouping useful information
• Intuitive: Not only developer-oriented
• Integrated: Works well with your existing tool suite
• Internationalized: Open to the world

Architecture

Frontend :

• JS (React, Apollo)
• CSS (Custom-made)

Backend :

• Node JS
• Prisma
• PostgreSQL

Backing services :

• Algolia (FullTextSearch-as-a-Service)
• Mailgun (Mail-as-a-Service)
• Auth0 (Auth-as-a-Service)

Integrations :

• Slack: Sending new questions into a dedicated channel and /faq command
• Workplace: Button to share questions
• Public API: Write your own integration to query the FAQ

Documentation

New to this project ?

• Step-by-step installation with only the required backing services

The full documentation is available here:

• https://zenika-open-source.github.io/FAQ/

License

This project is under the Apache License 2.0 - See the LICENSE.md file for details