8000 GitHub - skippskipp/annotator: An annotation database CRUD app using Firebase + Electron
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

skippskipp/annotator

Repository files navigation

Overview

Annotator is an Electron app using Firebase for authentication and storage. Create annotated citations (or other records for your db) and push them to Firebase. Configurable for multi-client and offline use.

Setup and Use

After cloning, initialize a Firebase project. Define user authentication settings as desired. Retrieve your Firebase project's config for apiKey, domain, url and id's. Create renderer.js in the root directory of Annotator, add in config with your Firebase project's reference:

var config = {
  apiKey: "RETRIEVE-FROM-YOUR-FIREBASE-PROJECT",
  serviceAccount: "./service-account.json",
  authDomain: "RETRIEVE-FROM-YOUR-FIREBASE-PROJECT",
  databaseURL: "RETRIEVE-FROM-YOUR-FIREBASE-PROJECT",
  projectId: "RETRIEVE-FROM-YOUR-FIREBASE-PROJECT",
  storageBucket: "",
  messagingSenderId: "RETRIEVE-FROM-YOUR-FIREBASE-PROJECT"
};
firebase.initializeApp(config);
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

License

CC0 1.0 (Public Domain)

About

An annotation database CRUD app using Firebase + Electron

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 25

0