Skip to content

Commit 08e047a

Browse files
committed
updated readme to provide setup instructions for local development/bootstrap
1 parent 5bdf43e commit 08e047a

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,57 @@
22

33
Voxxrin is your mobile conference companion.
44

5+
## Project bootstrap
6+
7+
Run `npm run bootstrap` (from root folder) once for all to install every required npm dependencies and initialize your local firebase emulator environment.
8+
9+
Then, to start both the backend (firebase emulator) and the frontend, simply run `npm run dev` from root folder.
10+
11+
On started, you should be able to open http://localhost:5173/ to access your local voxxrin instance.
12+
13+
## First crawler configuration
14+
15+
Open your firestore instance (you can access it locally through http://localhost:4000/firestore/default/data) then :
16+
- create a new root document (`Start collection` button) with:
17+
- collection id: `crawlers`
18+
- document id: `sample-event`
19+
- following fields:
20+
21+
| name | type | value |
22+
|------|------|--------|
23+
| descriptorUrl | string | `https://gist.github.com/fcamblor/6be34b50207d15f4d6202dfab780e409/raw/11661fb229ee4e0156908e2ca06d8a0c4f912619/videbays2025.json` |
24+
| eventFamily | string | `samples` |
25+
| eventId | string | `sample-event` |
26+
| eventName | string | `sample-event` |
27+
| kind | string | `single-file` |
28+
29+
- create another root document (`Start collection` button) with:
30+
- collection id: `public-tokens`
31+
- document id: `familyOrganizer:samples:ffffffff-ffff-ffff-ffff-ffffffffffff`
32+
- following fields:
33+
34+
| name | type | value |
35+
|------|------|--------|
36+
| eventFamilies | array of strings | `["samples"]` |
37+
| type | string | `FamilyOrganizerToken` |
38+
39+
- Once done, trigger a crawling for this new event using following curl command:
40+
```
41+
curl --request POST --url 'http://localhost:5001/voxxrin-v3/us-central1/api/crawlers/sample-event/refreshScheduleRequest?token=familyOrganizer%3Asamples%3Affffffff-ffff-ffff-ffff-ffffffffffff'
42+
```
43+
44+
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.
45+
546
## Project structure
647

7-
Voxxrin is a mobile app developed using ionic / capacitor + vue, wth a serverless backend relying on several Firebase services (auth, firestore, cloud functions).
48+
Voxxrin is a mobile app developed using ionic / capacitor + vue, with a serverless backend relying on several Firebase services (auth, firestore, cloud functions).
849

950
The mobile app is located in the `mobile` directory, and serverless firebase code is located in the `cloud` directory.
1051

1152
Each of these directories have their own `README.md` describing how to set them up.
1253

1354
## Tour of the features
1455

15-
1656
Look at [Feature showcase](https://github.com/voxxrin/voxxrin3/wiki/Voxxrin-3-features-showcase) to have an overview of currently-implemented Voxxrin features.
1757

1858
## How to add your own conference to the list ?

0 commit comments

Comments
 (0)