Merge branch 'main' into develop

Author: fcamblor

.nvmrc

@@ -0,0 +1 @@
+20

LICENSE

@@ -2,18 +2,63 @@
 
 Voxxrin is your mobile conference companion.
 
+## Project bootstrap
+
+Run `npm run bootstrap` (from root folder) once for all to install every required npm dependencies and initialize your local firebase emulator environment.
+
+Then, to start both the backend (firebase emulator) and the frontend, simply run `npm run dev` from root folder.
+
+On started, you should be able to open http://localhost:5173/ to access your local voxxrin instance.
+
+## First crawler configuration
+
+Open your firestore instance (you can access it locally through http://localhost:4000/firestore/default/data) then :
+- create a new root document (`Start collection` button) with:
+  - collection id: `crawlers`
+  - document id: `sample-event`
+  - following fields:
+
+| name | type | value  |
+|------|------|--------|
+| descriptorUrl | string | `https://gist.github.com/fcamblor/6be34b50207d15f4d6202dfab780e409/raw/11661fb229ee4e0156908e2ca06d8a0c4f912619/videbays2025.json` |
+| eventFamily | string | `samples` |
+| eventId | string | `sample-event` |
+| eventName | string | `sample-event` |
+| kind | string | `single-file` |
+
+- create another root document (`Start collection` button) with:
+  - collection id: `public-tokens`
+  - document id: `familyOrganizer:samples:ffffffff-ffff-ffff-ffff-ffffffffffff`
+  - following fields:
+
+| name | type | value  |
+|------|------|--------|
+| eventFamilies | array of strings | `["samples"]` |
+| type | string | `FamilyOrganizerToken` |
+
+- Once done, trigger a crawling for this new event using following curl command:
+```
+curl --request POST --url 'http://localhost:5001/voxxrin-v3/us-central1/api/crawlers/sample-event/refreshScheduleRequest?token=familyOrganizer%3Asamples%3Affffffff-ffff-ffff-ffff-ffffffffffff'
+```
+
+You should get a successful execution summary, and should be able to see *a new event* popping on your local voxxrin instance's `Past Events` tab.
+
 ## Project structure
 
-Voxxrin is a mobile app developed using ionic / capacitor + vue, wth a serverless backend relying on several Firebase services (auth, firestore, cloud functions).
+Voxxrin is a mobile app developed using ionic / capacitor + vue, with a serverless backend relying on several Firebase services (auth, firestore, cloud functions).
 
 The mobile app is located in the `mobile` directory, and serverless firebase code is located in the `cloud` directory.
 
 Each of these directories have their own `README.md` describing how to set them up.
 
 ## Tour of the features
 
-_To be added (once we have all the screens implemented)_
+Look at [Feature showcase](https://github.com/voxxrin/voxxrin3/wiki/Voxxrin-3-features-showcase) to have an overview of currently-implemented Voxxrin features.
 
 ## How to add your own conference to the list ?
 
-_To be detailed_
+Voxxrin is currently in a closed beta mode.
+
+However, if you are interested into adding your conference to the list, drop us an email at `contact` at `voxxr.in`, describing where we can retrieve your schedule (API ? Website ?).
+
+We will try to get back to you as soon as possible.

README.md

@@ -9,7 +9,10 @@
     "deploy:indexes": "npx firebase-tools deploy --only firestore:indexes --project ${FIREBASE_PROJECT_NAME:-voxxrin-v3} --force || true",
     "deploy": "concurrently 'npm run deploy:rules' 'npm run deploy:indexes'"
   },
-  "license": "Apache-2.0",
+  "license": "AGPL-3.0-only",
+  "engines": {
+    "node": "20"
+  },
   "devDependencies": {
     "@firebase/rules-unit-testing": "3.0.0",
     "@types/jest": "29.5.4",

cloud/firestore/package-lock.json

@@ -4,15 +4,16 @@
     "lint": "eslint --ext .js,.ts .",
     "build": "tsc",
     "build:watch": "tsc --watch",
-    "serve": "npm run build && env-cmd -f ./.env.local firebase emulators:start --import data --export-on-exit --inspect-functions",
+    "serve": "npm run build && env-cmd -f ./.env.local firebase emulators:start --import data --export-on-exit --inspect-functions --project ${FIREBASE_PROJECT_NAME:-voxxrin-v3}",
     "shell": "npm run build && firebase functions:shell",
     "start": "npm run shell",
     "deploy": "firebase deploy --only functions --project ${FIREBASE_PROJECT_NAME:-voxxrin-v3}",
     "logs": "firebase functions:log",
     "test": "vitest"
   },
+  "license": "AGPL-3.0-only",
   "engines": {
-    "node": "18"
+    "node": "20"
   },
   "main": "lib/cloud/functions/src/index.js",
   "dependencies": {

cloud/firestore/package.json

@@ -6,7 +6,10 @@
     "copy-from-mobile": "rm -Rf ./public/* && cp -a ../../mobile/dist/* ./public/",
     "deploy": "npm run copy-from-mobile && firebase deploy --only hosting --project ${FIREBASE_PROJECT_NAME:-voxxrin-v3}"
   },
-  "license": "Apache-2.0",
+  "license": "AGPL-3.0-only",
+  "engines": {
+    "node": "20"
+  },
   "devDependencies": {
     "firebase-tools": "13.6.0"
   }

cloud/functions/package-lock.json

@@ -1,16 +1,20 @@
+# Will use local firebase instances (run `npm run serve` from cloud/ directory) on local DEV env only
+VITE_USE_LOCAL_FIREBASE_INSTANCE=true
+# Same, but for auth
+VITE_USE_LOCAL_FIREBASE_INSTANCE_FOR_AUTH=true
+
 
 # If you want, you can override this property in the git-ignored .env.dev.local file
 # see https://vitejs.dev/guide/env-and-mode.html
-VITE_FIREBASE_API_KEY=<Please put your Public API Key here>
-VITE_FIREBASE_AUTH_DOMAIN=<Firebase Project>.firebaseapp.com
-VITE_FIREBASE_PROJECT_ID=<Firebase Project>
+VITE_FIREBASE_API_KEY=fake-voxxrin-v3-key
+#VITE_FIREBASE_API_KEY=<Please put your Public API Key here>
+VITE_FIREBASE_AUTH_DOMAIN=localhost
+#VITE_FIREBASE_AUTH_DOMAIN=<Firebase Project>.firebaseapp.com
+VITE_FIREBASE_PROJECT_ID=voxxrin-v3
+#VITE_FIREBASE_PROJECT_ID=<Firebase Project>
 VITE_FIREBASE_STORAGE_BUCKET=<Firebase Project>.appspot.com
 VITE_FIREBASE_MESSAGING_SENDER_ID=<Firebase Messaging ID>
 VITE_FIREBASE_APP_ID=<Firebase App ID>
-# Will use local firebase instances (run `npm run serve` from cloud/ directory) on local DEV env only
-VITE_USE_LOCAL_FIREBASE_INSTANCE=false
-# Same, but for auth
-VITE_USE_LOCAL_FIREBASE_INSTANCE_FOR_AUTH=false
 
 # Feature flags
 VITE_VIEWABLE_USER_DASHBOARD=true