Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zenika-open-source/faq
Internal Knowledge Database for your organization
https://github.com/zenika-open-source/faq
application graphql hacktoberfest internal-knowledge-database prisma react
Last synced: 7 days ago
JSON representation
Internal Knowledge Database for your organization
- Host: GitHub
- URL: https://github.com/zenika-open-source/faq
- Owner: zenika-open-source
- License: apache-2.0
- Created: 2018-02-02T15:26:15.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T05:04:42.000Z (4 months ago)
- Last Synced: 2024-12-26T03:06:42.927Z (14 days ago)
- Topics: application, graphql, hacktoberfest, internal-knowledge-database, prisma, react
- Language: JavaScript
- Homepage: https://demo.faq.team
- Size: 12.9 MB
- Stars: 61
- Watchers: 8
- Forks: 16
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# FAQ Zenika
Internal Knowledge Database for your organization - https://demo.faq.team
**:sparkles: Interested in having a hosted version of the FAQ for your organization? [Contact us!](mailto://[email protected])**
## 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](https://zenika-open-source.github.io/FAQ/#/getting-started) 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](https://github.com/zenika-open-source/FAQ/blob/main/LICENSE.md) file for details
