31 dic 2017

FireDocs: Create a knowledge base with Firebase

I just made a knowledge-base like site or documentation manager for my projects and I decided make it open because I didn't found a solution like this on internet. Feel free to use and modify the code, make sure to give some credit to the project leaving the Github link in the footer of the pages.
FireDocs: Knowledge base for project documentation


Project Highlights
  • Dashboard developed with AngularJS and Angular Material. Fully responsive.
  • Edit rich text articles (tinymce) and upload images.
  • Cross browser support, tested in the latest versions of Edge, Firefox, Chrome, Opera.
  • File uploader using your own Firebase Storage bucket.
  • Uses Firebase Functions to serve server-rendered articles with NodeJS.
  • Uses Firebase Firestore to store the articles and their metadata.
  • Support draft versions of articles for redaction-unfinished articles and sections.
  • Implements a simple template engine (developed by me) to render the pages.
  • SEO optimized and social networks friendly, ready to share articles.
  • Implements lazy-load for images and lightbox with keyboard actions.
  • Responsive user interface for documentation too, with no frameworks, just raw JavaScript and css. Super lightweight.
  • Simple and fully customizable HTML templates and styles.
  • Uses Firebase Hosting to host static files and handle your URLs for documentation e.g: https://example.com/docs/friendly-article-url
Demo
Web site in production: Ayuda de Asistente Factura Electrónica

See on Github
FireDocs

Installation
See installation guide

Security notes
The admin section uses Firebase Authentication, so "anyone" can log-in. Make sure to modify this behavior implementing custom auth or run it (like me) in localhost.
Anyway, the Firebase Rules for Storage for uploads and Firestore rules should be adapted for your needs. By default only certain users can upload and edit data (you set the admin's user id's).

Screenshots
Below you can see some screens of the version 1.
FireDocs home page and FAQ. CSS simple grid and customizable HTML
Article lightbox for images, with keyboard control.

Firebase Knowledge base article with right sidenav navigation for sections and articles and left content index like Google's documentation page.
Responsive documentation article
Responsive article editor for admins

Social login in the admin's side


Rich text editor

File uploader for images and files using Firebase Storage
File browser built-in to access old files uploaded

List of created articles. Public and draft states of the articles.

Sections tree ABM and it's articles. Reorder and visibility changes are available.

PD: This is my first contribution to open-source projects, so constructive comments and suggestions are welcome. Maybe in the future new versions come.

If you use this project make me know!, I'll be happy to see your implementation, just tweet or DM me @marianopaulin02

No hay comentarios.:

Publicar un comentario

Deja tu comentario aqui...