Essential Prerequisites for Developing with the Twinfinity Embedded API

Introduction

Embarking on the journey of developing a web application using the Twinfinity Embedded API involves several key prerequisites. This guide outlines all the necessary tools and knowledge you need to harness the full potential of Twinfinity's technology.

1. Access to a Twinfinity Site and Project
   
   To start, ensure you have access to a Twinfinity site and project. This access is the cornerstone of your development environment, serving as the primary platform to serve data and where you will integrate and utilize the API.
   
   

2. Package Manager: NPM/Yarn
   
   A fundamental requirement is a package manager like NPM (Node Package Manager) or Yarn. These tools are crucial for managing the dependencies in your project, including the installation and maintenance of the Twinfinity Embedded API and other essential libraries.
   
   

3. Whitelisted Custom Domain
   
   For security and functionality, your application’s domain must be whitelisted by us. Reach out to your local Twinfinity representative to facilitate this process, ensuring that your app can securely interact with the Twinfinity API
   
   

4. OpenID Connect: Client id and redirect url
   
   Twinfinity uses Open ID Connect (OIDC) authentication. If you do not already have an OIDC client id to a Twinfinity instance, please contact us. You will also need to provide a redirect url to a path below the domain where your project resides.
   
   

5. Proficiency in TypeScript
   
   The Twinfinity API makes extensive use of TypeScript. Familiarity with this language is paramount, as it enhances JavaScript with type annotations and other powerful features, contributing to more robust and error-resistant code.
   
   

6. Integrated Development Environment (IDE)
   
   A robust IDE, like Visual Studio Code, is highly recommended for an efficient development process. An IDE like Visual Studio Code is particularly well-suited for this purpose, offering excellent support for TypeScript and other web technologies.
   
   

7. Scaffold Projects for Angular, Vanilla, and React
   
   Twinfinity provides scaffold projects for popular frameworks such as Angular, Vanilla JavaScript, and React. These scaffolds offer a structured starting point for your project, saving time and ensuring you adhere to best practices from the outset.
   
   

Conclusion

Preparing for your project with these prerequisites sets a strong foundation for your development journey. From ensuring access to necessary resources to leveraging the power of TypeScript and scaffold projects, each element plays a critical role in the seamless creation of your web application.