Table of Contents generated with DocToc
-
The Database used for this project was a postgres server so if you don't have one available we recommend you install one now
-
For MAC
brew install postgresql
brew services start postgresql
psql postgres
CREATE DATABASE lemondb;
CREATE USER container WITH PASSWORD 'connection';
ALTER ROLE container WITH SUPERUSER CREATEDB;
\q
cd api
yarn migrate:init
- X-Code is required
-
Pull down this repository and
cd
into the root directory -
Copy the
.env.example
file
cp .env.example .env
- open the .env file
This app utilizes Twilio for it's Passwordless Auth
verification process as well as the Dial-By-Name
service. In order to at least have the api running for Auth you will need to have at least a free trial Twilio account.
- Passwordless Auth
- VERIFY_SERVICE_SID: click here for how to set that up.
- Dial-by-Name (Optional): requires setting up a TWIML app with ngrok
- TWILIO_NUMBER
- TWILIO_ACCOUNT_SID
- TWILIO_AUTH_TOKEN
Ngrok provides a way for Twilio to communicate with your local dev environment by providing a public url that is tunneled to your local running server. We configured it to automatically update Twilio with that url so there is no need to worry about manually copy and pasting the dynamic value ngrok provides.
-
You will need a
NGROK_TOKEN
which you can get for free by signing up here -
paste the token in the
.env
file
cd api
yarn install
yarn dev
- If Twilio was configured correctly you should see something like the following:
Server now available at https://079c-73-185-58-123.ngrok.io
Successfully updated Twilio voiceUrl to https://079c-73-185-58-123.ngrok.io/api/voice/gather
2022-04-28 04:30:34.837 INFO 🚀 Server ready at: http://localhost:3030
- If you have never ran X-Code locally before you'll need to make take the time to make sure you have a working xcode environment that builds correctly.
cd app
yarn install
yarn ios
- if everything is configured correctly the simulator should pop up for you and and app will load momentarily.