@icure/cra-template-typescript-cardinal-sdk
v1.0.1
Published
![Cardinal logo](./cardinal_logo.svg)
Downloads
6
Keywords
Readme
Start working on your e-health React JS app with Cardinal in a few minutes, by using our dedicated React JS template:
yarn create react-app my-health-tech-app --template @icure/cra-template-typescript-cardinal-sdk
Once your app is created, rename the file .env.default
to .env
, complete the values it contains:
- REACT_APP_EXTERNAL_SERVICES_SPEC_ID,
- REACT_APP_EMAIL_AUTHENTICATION_PROCESS_ID and/or REACT_APP_SMS_AUTHENTICATION_PROCESS_ID,
- REACT_APP_PARENT_ORGANISATION_ID,
- REACT_APP_FRIENDLY_CAPTCHA_SITE_KEY
And start your React app by executing
cd my-health-tech-app && yarn start
Check out our Quick Start in order to know what are those information and how to get them from our Cockpit Portal.
WARNING: Without these information, you won't be able to complete an authentication
Not familiar with create-react-app
? Have a look to their repository.
Looking for React Native template instead ? Head here.
Requirements
Make sure the following tools are installed on your machine:
- NodeJS (Node 16 + at least)
- Yarn Package manager
Which technologies are used ?
- ReactJS
- Redux Toolkit, as a state container
- localForage, as an asynchronous Javascript storage
- FriendlyCaptcha, as a CAPTCHA solution
We chosed this set of technologies, because we consider them as the most efficient ones to work with. Nonetheless, you can of course work with the technologies of your choices and still integrate the iCure MedTech Typescript SDK in your React JS app.
What includes this template ?
- The Cardinal SDK dependency;
- A first implementation of the authentication flow, both registration and login.
What's next ?
Check out our Documentation and more particularly our How To's, in order to start implementing new functionalities inside your React JS App !