Installation

1. Add Database, Social & Mailgun Settings

Navigate to the folder where you downloaded Gravity and open the .env & /config/default.json files located in the /server folder and then populate your database and Mailgun credentials.

If you're on the Power plan, you can use the setup wizard included with the React web client.

To use social sign-ons you must add your Facebook and Twitter API keys to the .env file and also the callback URLs to /config. See the section on Social Sign-Ons for more information.

You must complete this step before proceeding.

2. Install Expo

The Expo CLI will enable you to perform various Expo tasks, like running and building your app.

npm install expo

3. Download the Expo Mobile Client

On your iOS or Android mobile device, visit the respective app store, download the Expo mobile client then register a free account.

4. Install Gravity Native

The installation process is the same as described in the server installation instructions, except you must specify your desired database driver if not using MySQL.

// standard (mysql2)
npm run setup

// mongo
npm run setup db:mongo

// postgres
npm run setup db:pg

This will install all of the dependencies required. Once the installation process has finished, you can start your app:

cd app
npx expo start

If you open the Expo mobile app or iOS or Android simulator, you can see your app.

Inside /app/config.json is a baseURL setting that points to the Gravity server for making API calls. During setup, this will be automatically set to your local network address, but you should update this to point to your development server.

5. Install ngrok (optional)

If you want to use social sign-ons in your application, you must install ngrok to handle the redirects.

Once installed, please update the callback_url inside the /config folder files and also the baseURL value inside app/config.json

6. Add Expo Project ID

Create a new Project in your Expo account and copy and paste the Project UUID to app.json → expo.extra.eas.projectId for notifications to work.

Running Your App

Finally, to run your app any time, enter the following command.

npx expo start

This will start both Gravity Server and the Expo client.

Running in a Simulator

Once your Expo server is running, you can open your app in the Android simulator by pressing a or i to open the iOS simulator.