Merge pull request #12 from ciatph/dev

v1.0.9

.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es6: true
+  },
+  extends: [
+    'standard',
+    'eslint:recommended'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2022
+  },
+  rules: {
+    'indent': ['error', 2],
+    'linebreak-style': ['error', 'unix'],
+    'quotes': ['error', 'single'],
+    'semi': ['error', 'never']
+    // 'no-console': ['error', { 'allow': ['error'] }]
+    // 'no-unused-vars': 'off',
+    // 'no-undef': 'off'
+  }
+}

.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: Lint Files
+
+on:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  lint-server:
+    name: Lint App
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v1
+      - name: Use NodeJS ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - name: Install Dependencies and lint
+        run: |
+          npm install
+          npm run lint

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 .env
 .vscode
 *.csv
+*.zip

.npmignore

@@ -2,3 +2,4 @@ node_modules/
 .env
 .vscode
 *.csv
+*.zip

README.md

@@ -48,8 +48,10 @@ Will be stored in a Firestore collection `playable_characters`, where each CSV r
 
 ## Requirements
 
+The following dependencies are used for this project. Feel free to use other dependency versions as needed.
+
 1. Windows, Mac or Linux OS
-2. NodeJS version 14.18.3 or higher
+2. NodeJS version 16.14.2
 3. Access to a Firebase Project [[link]](https://firebase.google.com/)
    - Pricing Plan: Spark plan or higher
    - Service account credentials JSON file
@@ -71,7 +73,7 @@ Will be stored in a Firestore collection `playable_characters`, where each CSV r
 
 (See package.json for more information.)
 
-1. [firebase-admin](https://www.npmjs.com/package/firebase-admin) v10.0.2
+1. [firebase-admin](https://www.npmjs.com/package/firebase-admin) v11.0.1
 2. [fast-csv](https://www.npmjs.com/package/fast-csv) v4.3.6
 
 

examples/example-firestore.js

@@ -0,0 +1,26 @@
+const { FirestoreData } = require('../index')
+
+// Demonstrates custom Firestore queries
+// with direct usage of firebase-admin's firestore and admin objects
+const main = async () => {
+  const Firestore = new FirestoreData()
+
+  try {
+    const firestoreCollection = 'my_books_collection'
+    const id = Firestore.db.collection(firestoreCollection).doc().id
+
+    const logs = await Firestore.db
+      .collection(firestoreCollection)
+      .doc(id)
+      .set({
+        id,
+        title: 'My Favorite Book',
+        date_created: Firestore.admin.firestore.Timestamp.now()
+      })
+    console.log(logs)
+  } catch (err) {
+    console.log(err.message)
+  }
+}
+
+main()

index.js

@@ -1,6 +1,6 @@
 require('dotenv').config()
 const ParserCSV = require('./src/lib/classes/parser')
-const FirestoreData = require('./src/lib/classes/firestore-data')
+const FirestoreData = require('./src/lib/classes/firestore-data/firestore-data')
 const CsvToFireStore = require('./src/lib/classes/csvtofirestore')
 
 module.exports = {