Getting Started

Install

1. Install & swap to the correct version of node:

npm run installNode
npm run swapNode

This assumes you have nvm installed. Other wise you'll need to install node 20.11.0 manually.

2. Install typescript globally

npm run installTypescript

This will install typescript 4.5.5 globally.

3. Install the projects dependencies

npm install

Starting a new Project

1. Duplicate the .env.example and rename the new file .env
2. Duplicate the src\applications\GetStarted folder and re-name the folder to the name of your app. In this example we are naming the folder YourNewApp.
3. In your new apps folder open the Index.tsx and rename the react component to that of your app.
4. Register your app in src\App.tsx

    {APP === "YourNewApp" && (
        <ScreenContainer className="ScreenContainer fill-screen">
          <YourNewApp />
        </ScreenContainer>
    )}

5. In the .env file set `` to your apps name.

# Set which app should included from the aplications folder.
# These apps are registered with in src/App.tsx.
APP=YourNewApp

6. Start the project in development mode with npm start