Getting Started

Get your service provisioned

Typically, your White Label Data application instance is hosted by Hashpath on our cloud infrastructure. Hashpath will provision and configure your application, create your GitHub repository, and set up authentication with Auth0 on your behalf. You can reach us any time at hello@hashpath.com.

Note: If you need multiple instances for development and production, please let us know.

Get your setup info

Once completed, you will need the following information from Hashpath to set up your local development environment:

Name Example
GitHub Repository URL https://github.com/Hashpath/myapp.git
Auth0 Key t1zWLW0nsI2oSXpIZWRWnKralxVRxtItF8_ZfZrb_P0
Auth0 Secret deUpDMOwSOdOt6JZS4z4xsl4KsVIJg3KvNhIpiCzTrKwpWQ-v1YwPc-iadDBW5Wb3hAslo0N0sqjjn55zrITFw
Auth0 Domain mydomain.auth0.com

Check out your git repository

Hashpath will provide you with a GitHub repository to get your started. It will have basic templates and our Bigfoot Demo that you can use as a starting point. Clone the repository as follows from the MacOS Terminal or Windows Command Prompt:

git clone https://<your_repository_url>

Or follow this guide to use GitHub Desktop.

Set up your local development environment

You will need to have Docker installed on your local machine. You can use Docker for the Mac or Docker for Windows or any other docker environment, such as Linux.

In order to access the private DockerHub images for White Label Data, you must first login:

docker login

Create a file called docker-compose.yml with the following contents somewhere on your machine that you will remember. You need to replace <local_repository_path> with the path of the local repository that was created above with the clone command. You also need to substitute <auth0_key>, <auth0_secret>, and <auth0_domain> below with the info provided from your setup.

version: '3'

services:

  wldstatic:
    image: hashpath/hashpathapp-static:dev
    container_name: wldstatic
    restart: always
    ports:
      - "2526:80"
    volumes:
      - <local_repository_path>/static:/opt/services/static/wldinstance
      - /opt/services/logs

  wldinstance:
    image: hashpath/hashpathapp:dev
    container_name: wldinstance
    restart: always
    ports:
      - "2525:80"
    volumes:
      - <local_repository_path>:/opt/services/hashpathapp/hashpathcustomer/config
      - <local_repository_path>:/opt/services/hashpathapp/hashpathcustomer/templates/custom
    environment:
      - "HASHPATH_APPNAME=wldinstance"
      - "VIRTUAL_HOST=localhost"
      - "STATIC_URL=http://localhost:2526"
      - "AUTH0_DOMAIN=hashpathapp.auth0.com"
      - "AUTH0_KEY=<auth0_key>"
      - "AUTH0_SECRET=<auth0_secret"
      - "AUTH0_API_DOMAIN=<auth0_domain>"
      - "HASHPATH_DEBUG=True"
      - "HASHPATH_LOCAL=True"
      - "MAPBOX_TOKEN=pk.eyJ1IjoiaGFzaHBhdGgiLCJhIjoiY2p3Z3pxbHB0MDFrZDQzbnMwNmF1d3MybyJ9.0lLpesaHfYsX0-UivfyCzw"

Start your instance

From the MacOS Terminal or Windows Command Prompt, change directory to the path that you saved the docker-compose.yml file. For example:

cd /Users/john/mywldfolder

And start your instance:

docker-compose up -d

Connect to your development instance

From your web browser, go to http://localhost:2525 to see your app running.

Make changes to your White Label Data files using an editor

The rest of the documentation covers the layout of your project folders and how to make configuration changes to your application. You can use any text editor that you like, such as Sublime, Atom, or Vim.

Commit and Push your changes back to GitHub

In order for your changes to be deployed to your production server, you must commit and push them to the GitHub repository. This can be done using the command line or through the GitHub Desktop application.

From the command line:

git add *
git commit -m "My first commit"
git push

Verify that your changes have been deployed

White Label Data allows you to use your own domain name in production. Once your changes have been pushed to GitHub, they will be automatically deployed to production. At this point, you can see your updated changes in your web browser by going to your custom domain from the browser.