README.md

Jobber App Template - React

The primary objective of this React template is to provide a starting point to integrate your app with Jobber using Jobber's components system, Atlantis.

Table of contents

• What is this App for?
• OAuth flow
• Expected result
• Getting started
  • Prerequisites
  • Setup
  • Running the app
• Deployment
  • Deploying with Heroku
• Learn More
• Need help of have an idea?
• License

What is this APP for?

This React App Template is meant to be a quick and easy way to get you up to speed using Jobber's GraphQL API. This App consumes the Ruby on Rails API Template that handles authentication through Jobber's Developer Center and a few GraphQL example queries.

OAuth flow

The authentication flow is done by both apps, the frontend is responsable to receive the code returned from Jobber's GraphQL API once the users goes through the oauth and allow the app to connect to they jobber account.

On this App you will find an Auth route that will handle redirection to the OAuth flow, recieving the code, sending it to the rails backend and redirecting the user to the home page of the app if everything is sucessful.

Note: An App needs to be created on Jobber's Developer Center, and the environment variables described in .env.sample need to be configured in order to make the oauth redirection.

You should see a screen similar to this, asking you to grant access to the app:

Expected result

After granting access to the app, you should expect something like this:

Getting started

Prerequisites

• Node 16

  • Installation process can be found at https://nodejs.org/en/download/

• Jobber App

  • Create a developer account:
    • https://developer.getjobber.com/
  • Create new app:
    • Follow the docs to get started: https://developer.getjobber.com/docs
    • Your app must have (as a minimum) read access to Clients and Users under the Scopes section, in order for this template to work:

Setup

1. Install dependencies

   • npm ci

2. Setup environment variables

   • cp .env.sample .env

     Make sure to have the correct env values.

3. Start the backend API

   • You can find the fully configured Ruby on Rails API used for this template here

Running the app

• npm start

Deployment

This template comes with a Procfile configured so you can easily deploy on Heroku, however, you can deploy this API on the platform of your choice.

Deploying with Heroku

1. Install the Heroku CLI.

2. Log in to you Heroku account:

   • heroku login

3. Create a new Heroku app, this can be done from your browser or using Heroku's CLI in your terminal:

   • heroku create <name-of-your-app>

4. Verify the git remote was added with git config --list --local | grep heroku or add the heroku remote yourself:

   • git remote add heroku <heroku-app-url>

5. Deploy

   • git push heroku main

To learn more about deploying on Heroku:

• https://devcenter.heroku.com/categories/deployment

Learn More

Checkout Jobber's API documentation for more details on its setup and usage.

You can learn more about Create React App in the documentation.

To learn React, check out the React documentation.

For more information on Heroku, visit the Heroku Dev Center.

Need help or have and idea?

Please follow one of these issue templates if you'd like to submit a bug or request a feature.

License

The template is available as open source under the terms of the MIT License.