Skip to main content

Domain Conventions

App Names

JOD has two apps:

  • Gig: Gig Workforce Procurement & Management (Singapore clients)
  • Pro: Payroll Management (Philippines clients)

Both apps have their own API service, independent of each other.

note

In the future, we want to eventually merge these two apps into one app, called jodapp.com. To keep things simple, we will have them separate until we have clear requirements on both apps.

App Definitions

The following section will use jodapp.com as the domain to define the conventions.

We will use the app name as a subdomain to differentiate them.

  • We also have to consider that each app has it's own API service.

The single app Gig in the jodapp.com domain:

  • gig.jodapp.com is the subdomain for JodGig frontend
  • api.gig.jodapp.com is the subdomain for JodGig API service

We would do the same for the single app Pro in the jodapp.com domain:

  • pro.jodapp.com is the subdomain for JodPro frontend
  • api.pro.jodapp.com is the subdomain for JodPro API service

This will give us:

appenvironmentroledomaininstance host name
gigproductionfrontendgig.jod.com.sgjodgig.qa.frontend
gigproductionapiapi.gig.jod.com.sgjodgig.qa.api

Environments

"Environments" is a term used to refer to the different states of the app.

NameDescription
qaUsed for devs and testers to test changes in their respective branches.
demoStable environment which is up to date with production. Used by business/sales to demo to clients.
prodStable environment used by paying clients.

This will give us the following complete domain map.

URL Conventions

Before we begin, let's define our URL conventions.

We will have 2 level subdomains in our urls, to follow a best practices of having to issue separate wildcard SSL certificates for each subdomain.

Example using jodapp.com domain:

environmentapproot domainfinal domain
qagigjodapp.comqa.gig.jodapp.com
demoprojodapp.comdemo.pro.jodapp.com