-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
Welcome to the getting started guide. This app runs on Firebase, a suite of software tools created by Google that work to help you quickly build web and mobile apps. Eventually, you'll have to configure a Firebase project but this page will just cover the basics.
Before starting, make sure you have this repository cloned locally 💻
If you get stuck, feel free to create an issue or email me at jsmith@hey.com. These instructions aren't simple and I definitely have some mistakes.
First, you'll have to make sure you have node v12 and npm installed correctly. If not installed, we recommend the following steps to getting them set up.
- Install Node Version Manager (NVM)
- Install Node and npm using NVM
Although these instructions use
npm,yarncan also be used if desired.
You can install all of the dependencies in one go using the following command.
npm run bootstrap
This runs npm install in the root the repository and in the app, functions and native-audio folders. It also symlinks shared to app/shared, functions/shared and scripts/shared.
⚠️ ⚠️ ⚠️ Are you using Windows?⚠️ ⚠️ ⚠️ You will have issues with the symlinks I use to share code between packages. If this happens to you and you're stuck, feel free to file an issue.
We install firebase-tools during this process. This Firebase CLI will be used in future steps so definitely check out the documentation.
Next, install the gcloud and the gsutil Google Cloud CLI utilities. You'll use these to configure Google Cloud Storage settings.
curl https://sdk.cloud.google.com | bash
exec -l $SHELL
See the official gsutil installation documentation here.
If you want to turn on Sentry, sign up for an account, create your own project and then retrieve your project's DSN value. For now, just save this value :)
Send Grid is an email service that Relar uses to send emails to users. You will need an API key to get the sign up system to work. Here is some documentation that explains how to get an API key.
At this point in the setup guide, you need to configure your app to point to a Firebase project. If you want to get access to Relar's staging environment for local development, you can email me at jsmith@hey.com. Alternatively, follow the Firebase Setup guide to configure your own project.
Finally, login to your Google account. You'll need to be logged in to deploy and for local development.
npx firebase-tools login
Once you've completed all of these steps, check out the development/deployment/testing guides or read through the tech/architecture information pages.