This template succeeds the previous react-template. This is re-write is based on create-react-app and is designed mainly to provide a simple and familiar developer experience.

This template contains functional examples of how the user flow and interaction with the Digital Person should work, and likley require styling chanages to suit branding requirements.

In order to run this application, you'll either need an API key or a token server. Most projects will use an API key--token servers are only necessary when interfacing with a non-native NLP through a orchestration server.

Create an empty text file called .env and copy the contents of .env.example into it. These environment variables are required for the UI to run.

If using an API key, set REACT_APP_PERSONA_AUTH_MODE to 0 and populate REACT_APP_TOKEN_URL with your key.

If using an orchestration server, set REACT_APP_PERSONA_AUTH_MODE to 1 and populate REACT_APP_TOKEN_URL with your token server endpoint and set REACT_APP_TOKEN_URL to true.

Run to install the project's dependencies.

Starts the development server. Open http://localhost:3000 to view it in the browser. The page will automatically reload when you make changes.

Builds the app for production to the build folder. The files will be bundled and minified for production.

Soul Machines React Reference UI is available under the Apache License, Version 2.0. See the LICENSE.txt file for more info.

This project strictly follows AirBnB's JavaScript style guide. We recommend you install ESLint in your editor and adhere to its recommendations.

We have also provided an .editorconfig file that you can use in your editor to match the indentation, whitespace, and other styling rules we used in creating this template.

Our team would love to hear from you. For any additional support, feedback, bugs, feature requests, please submit a ticket or reach out to us at [email protected].