Git Product home page Git Product logo

nodejs-wiki's Introduction

Firebase Wiki

A modern wiki for the modern world.

Powered by Firestore!

Features

  • Supports Markdown to HTML
  • History support
  • Infoboxes and wiki links
  • Discussion pages
  • Special pages
  • Only one individual can edit code at a time
  • Authentication to restrict access to reading and/or writing

Setup

  • Create a Firebase project
    • Setup Firestore and authentication
  • Run yarn
  • Run yarn create-firebase-config
  • Run yarn build-wiki
  • Run firebase init and select Hosting for your project
  • Deploy with yarn serve
    • Or develop locally with yarn serve-local

Note: If you are deploying to a system with git, you should remove dist/ from .gitignore and commit the main.js file.

Firestore Structure

(Collections are all caps, documents all lowercase, fields denoted by stars)

WIKIPAGES
    home
        * title = "Home"
        * lastupdated = timestamp()
        * editing = true/false
        DELTAS
            <id>
                * delta = "[]" (JSON stringified changes array)
                * commit = "Some change reason"
                * authorId = "Identifier of a user"
                * authorName = "Display name of the user"
                * pageTitle = "The current title of the page"

License

See LICENSE.

nodejs-wiki's People

Contributors

fleker avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.