Firebase Cloud Functions require a paid account to make outbound API calls. This includes API calls to HyperTrack APIs. We recommend using the Blaze plan. It gives a lot of bandwidth for free, which is more then enough to internally test the app.
- Clone the repo.
git clone https://github.com/hypertrack/ridesharing-firebase.git
cd ridesharing-firebase
- Install Firebase tools CLI
npm install -g firebase-tools
- Login to your account and choose your project
firebase login
firebase use --add
Select the project from dropdown menu. You can use any alias for the project.
- Install function dependencies
cd functions ; npm install ; cd ..
- Configure functions with HyperTrack API Keys
Copy AccountId
and SecretKey
from HyperTrack's dashboard setup page. Paste them in /functions/index.js
file into placeholders on line 9. Keep the :
separator between them.
- Deploy functions into your Firebase Ridesharing project
firebase deploy --only functions
- Setup webhooks from HyperTrack to Cloud Functions
- Open the Functions > Dashboard tab in your Firebase project
- Copy the trigger URL for
onTripUpdate
function - Go to HyperTrack's dashboard setup page and add this URL as a webhook URL.
- Your Cloud Functions backend is now ready to interface with HyperTrack APIs.
For detailed documentation of the APIs, customizations and what all you can build using HyperTrack, please visit the official docs.
No project active. Run with --project <projectId> or define an alias by
running firebase use --add
This error while deploying functions means that you need to select the project first. Run firebase use --add
and select your project from dropdown menu, then add any alias to the project.
This error can happen when your didn't run npm install
from the functions
directory. Run cd functions ; npm install ; cd ..
from the projects directory or execute the commands one by one:
cd functions
npm install
cd ..