# web-whitelabel

> White label version of the TK web app

Latest version **1.15.0** (published 2022-04-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install web-whitelabel
pnpm add web-whitelabel
yarn add web-whitelabel
bun add web-whitelabel
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.15.0 |
| Published | 2022-04-13 |
| First published | 2020-10-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 61 |
| Unpacked size | 418 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tkvr-integration |

## Links

- npm: https://www.npmjs.com/package/web-whitelabel
- Repository: https://github.com/TurnKeyVR/web-whitelabel
- Homepage: https://github.com/TurnKeyVR/web-whitelabel#readme
- Issues: https://github.com/TurnKeyVR/web-whitelabel/issues
- npm.io page: https://npm.io/package/web-whitelabel

## Dependencies (61)

- [yup](https://npm.io/package/yup.md) ^0.28.3
- [next](https://npm.io/package/next.md) ^9.5.5
- [uuid](https://npm.io/package/uuid.md) ^8.3.0
- [react](https://npm.io/package/react.md) ^16.9.0
- [redux](https://npm.io/package/redux.md) ^4.0.5
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [formik](https://npm.io/package/formik.md) ^2.0.4
- [express](https://npm.io/package/express.md) ^4.16.4
- [graphql](https://npm.io/package/graphql.md) ^14.6.0
- [webpack](https://npm.io/package/webpack.md) ^4.39.2
- [@xdn/cli](https://npm.io/package/@xdn/cli.md) ^2.53.4
- [date-fns](https://npm.io/package/date-fns.md) ^1.29.0
- [mongoose](https://npm.io/package/mongoose.md) ^5.9.20
- [react-ga](https://npm.io/package/react-ga.md) ^2.7.0
- [@xdn/core](https://npm.io/package/@xdn/core.md) ^2.53.4
- [@xdn/next](https://npm.io/package/@xdn/next.md) ^2.53.4
- [react-dom](https://npm.io/package/react-dom.md) ^16.9.0
- [@xdn/react](https://npm.io/package/@xdn/react.md) ^2.53.4
- [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.9.1
- [react-redux](https://npm.io/package/react-redux.md) ^7.2.0
- [react-slick](https://npm.io/package/react-slick.md) ^0.23.1
- [apollo-boost](https://npm.io/package/apollo-boost.md) ^0.4.7
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.0.6
- [query-string](https://npm.io/package/query-string.md) ^6.13.7
- [react-apollo](https://npm.io/package/react-apollo.md) ^3.1.3
- [react-map-gl](https://npm.io/package/react-map-gl.md) ^5.2.9
- [shuffle-seed](https://npm.io/package/shuffle-seed.md) ^1.1.6
- [connect-mongo](https://npm.io/package/connect-mongo.md) ^3.2.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.4
- [lodash.sortby](https://npm.io/package/lodash.sortby.md) ^4.7.0
- [webfontloader](https://npm.io/package/webfontloader.md) ^1.6.28
- [@turnkeyvr/env](https://npm.io/package/@turnkeyvr/env.md) ^4.0.2
- [@zeit/next-css](https://npm.io/package/@zeit/next-css.md) ^1.0.1
- [card-validator](https://npm.io/package/card-validator.md) ^6.2.0
- [react-truncate](https://npm.io/package/react-truncate.md) ^2.4.0
- [@types/mongoose](https://npm.io/package/@types/mongoose.md) ^5.7.1
- [express-session](https://npm.io/package/express-session.md) ^1.15.6
- [@reduxjs/toolkit](https://npm.io/package/@reduxjs/toolkit.md) ^1.2.5
- [react-stickynode](https://npm.io/package/react-stickynode.md) ^2.1.1
- [@apollo/react-ssr](https://npm.io/package/@apollo/react-ssr.md) ^3.1.3
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.9.5
- [styled-components](https://npm.io/package/styled-components.md) ^5.1.1
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.9.1
- [next-redux-wrapper](https://npm.io/package/next-redux-wrapper.md) ^5.0.0
- [@material-ui/styles](https://npm.io/package/@material-ui/styles.md) ^4.9.0
- [@turnkeyvr/common-ui](https://npm.io/package/@turnkeyvr/common-ui.md) ^2.40.26
- [@types/cookie-parser](https://npm.io/package/@types/cookie-parser.md) ^1.4.2
- [react-image-lightbox](https://npm.io/package/react-image-lightbox.md) ^5.1.1
- [@turnkeyvr/ab-testing](https://npm.io/package/@turnkeyvr/ab-testing.md) ^1.2.4
- [@turnkeyvr/common-lib](https://npm.io/package/@turnkeyvr/common-lib.md) ^2.12.7
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^0.21.0
- [@types/express-session](https://npm.io/package/@types/express-session.md) ^1.15.16
- [@zeit/next-source-maps](https://npm.io/package/@zeit/next-source-maps.md) 0.0.3
- [@turnkeyvr/common-types](https://npm.io/package/@turnkeyvr/common-types.md) ^2.25.3
- [@turnkeyvr/common-utils](https://npm.io/package/@turnkeyvr/common-utils.md) ^1.6.0
- [material-ui-popup-state](https://npm.io/package/material-ui-popup-state.md) ^1.0.1
- [@turnkeyvr/website-state](https://npm.io/package/@turnkeyvr/website-state.md) ^0.6.3
- [babel-plugin-inline-import](https://npm.io/package/babel-plugin-inline-import.md) ^3.0.0
- [@turnkeyvr/react-day-picker](https://npm.io/package/@turnkeyvr/react-day-picker.md) ^7.2.8
- [@turnkeyvr/localstoragewrapper](https://npm.io/package/@turnkeyvr/localstoragewrapper.md) ^1.0.1
- [babel-plugin-styled-components](https://npm.io/package/babel-plugin-styled-components.md) ^1.10.0

## Recent versions

- 1.15.0 (latest) — 2022-04-13
- 1.11.0-beta.10 (beta) — 2020-12-02
- 1.14.0 — 2022-02-03
- 1.12.0 — 2020-12-02
- 1.11.0-beta.9 — 2020-11-19
- 1.11.1 — 2020-11-18
- 1.11.0-beta.8 — 2020-11-18
- 1.11.0-beta.7 — 2020-11-18
- 1.11.0 — 2020-11-18
- 1.11.0-beta.6 — 2020-11-18
- 1.11.0-beta.5 — 2020-11-18
- 1.11.0-beta.4 — 2020-11-18
- 1.11.0-beta.3 — 2020-11-13
- 1.11.0-beta.2 — 2020-11-13
- 1.11.0-beta.1 — 2020-11-13
- … 14 more at https://npm.io/package/web-whitelabel/versions

## README

# 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](https://nextjs.org/docs/#setup).
It is also written in TypeScript [docs](https://www.typescriptlang.org/) 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](https://nextjs.org/docs/#cdn-support-with-asset-prefix) 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.

---
_Source: https://npm.io/package/web-whitelabel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._