Giter Site home page Giter Site logo

kp-marczynski / songbook Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 18.83 MB

PWA songbook with auto-scroll and real time auto-sharing currently playing song with campfire participants

License: GNU General Public License v3.0

JavaScript 28.62% TypeScript 55.33% HTML 9.37% CSS 6.68%
angular ionic indexeddb firebase-auth firestore

songbook's Introduction

Songbook

PWA songbook with auto-scroll and real time auto-sharing currently playing song with campfire participants.

Alternative version

Second version of this app is being developed in React: https://github.com/kp-marczynski/songbook-react

Demo

Prerequisites

How to start

First run npm install and then npm start or ionic serve

How to use with Firebase

  • create firebase project

  • add web app to firebase project and copy firebaseConfig to environment.ts file

  • create firestore database and add security rules:

    rules_version = '2'; service cloud.firestore { match /databases/{database}/documents {

      match /songs/{songId} {
      	allow read, update, delete: if resource.data.owner == request.auth.uid && request.auth.uid == <<your_firebase_uid>>;
        allow create: if request.resource.data.owner == request.auth.uid && request.auth.uid == <<your_firebase_uid>>;
      }
    
      match /campfire/{campfireId} {
      	allow update, delete: if resource.data.owner == request.auth.uid && request.auth.uid == <<your_firebase_uid>>;
        allow create: if request.resource.data.owner == request.auth.uid && request.auth.uid == <<your_firebase_uid>>;
        allow read: if true;
        allow list: if false;
      }
    
      // deny rest
      match /{document=**} {
        allow read, write: if false;
      }
    }
    

    }

In place of <<your_firebase_uid>> use your real firebase uid. This rules guarantees only you would be able to insert data to firebase which will prevent extra costs during development phase due to Firestore pricing.

How to deploy

ionic build --prod 
firebase login
firebase deploy

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.