FIRESTORE NOTES APP

This is very simple notes app which uses the Firestore database to store notes while looking good.

REQUIREMENTS

• A Google account for Firebase console.

• A local server. Recomended: npm install -g live-server.

INSTALLATION

• clone the repo using git clone https://github.com/utkarshbhatt12/firestore-notes.

• cd into firestore-notes.

• Go to https://console.firebase.google.com and create a new project with whatever name and the appropriate country. You'll be redirected to the project Get started here page.

• Click on Add Firebase to your web app and copy the config.

• Open the /js/firebase/__init.js in your favorite text editor and add the replace the config keys on the top of the file. The keys look like this:

firebase.initializeApp({
    apiKey: "",
    authDomain: "",
    databaseURL: "",
    projectId: ""
});

• Now go the console again, and click on Database > GET STARTED. Select Cloud Firestore if (when) given the choice.

• Click on the RULES tab, and change the read, write rule to allow always. The rules should look as follows:

service cloud.firestore {
    match /databases/{database}/documents {
        match /{document=**} {
            // NOTE: don't use something like this prod...
            allow read, write: if true;
        }
    }
}

• In the firestore-notes directory, run the live server using live-server index.html. The app should start running at http://127.0.0.1:8080/ on your default browser.

TODO

• Add notes reading functionality

• Add edit functionality

• Add search functionality

• Clear inputs after pressing SAVE

• Remove note data from sessionStorage after a successful SAVE operation to the Firestore

LICENSE

MIT License

Copyright (c) 2018 UTKARSH BHATT