web-whitelabel v1.15.0

web-whitelabel

White label version of the TurnKey web app.

Getting Started

This application is built using Next.js. If you are not familiar with Next or want a refresher, check out the docs. It is also written in TypeScript docs and uses nodemon to automatically re-compile changes on both the client and server.

• Make sure you are in the root of the project
• Grab the local.json file (located in s3 at tkvr-cred-store/local-configs/web-whitelabel) and place it in the config/ folder.
• Create a .env file at the root of the project.
  • Add REACT_SPINKIT_NO_STYLES=true to the .env file
• Run npm install
• If you don't already have nodemon and ts-node installed globally, do so by running npm install nodemon -g and npm install ts-node -g
• Build the project by running npm run build
• Start the project in development mode by running npm run start:dev

Local configuration

The local.json file has a key for nextjs and default values as follows:

{
    ...

    "nextjs": {
        "useAssetPrefix": false,
        "buildType": "development"
    }

    ...
}

The useAssetPrefix key allows us to set an assetPrefix for test/production servers while we have the application load balanced (so we can slowly migrate pieces of the site).

The buildType key determines how Next builds/serves the application.

• If it is set to production it will build the entire application before starting up the server, allowing for what is essentially a static bundle for the application (which gives us a large increase in performance).
• If it is set to development it will build the application on the fly and reload the application on any code changes. This allows for rapid iteration and should only be used for local development.