Getting Started

It's fairly quick and easy to get started with the framework. We have some NPM packages available to give you a kick start or you can clone directly from source. For NPM, you will need to be a member of the CommonTime organisation and have an active logged in session in your terminal.

NPM

Getting started via NPM is the easiest way. Start by installing in the application generator like so:

install -g @commontimeltd/infinity-framework-app-generator

Once installed, you can then run the global command:

cti-gen-app YourAppName

Note

When creating an application you will want to name it using TitleCase.

This will create a new folder called YourAppName in the directory where you ran the command.

From there you just need to run the standard npm install inside the app directory.

From Source

Getting started from source is a little more involved. You will need to clone the application template from:

https://bitbucket.org/commontime/infinity-framework-app-template

Clone this into a directory of its own. You will also need to run npm install again to install all dependencies.

When cloning from source, you will also have to go through the code base and ensure your app name is used correctly. This is why cloning from source isn't really recommended.

VS Code Tools

It's also worth grabbing the VS Code tools as they contain a number of features which are useful when building apps. They can be found on the link below with instructions on how to install:

https://bitbucket.org/commontime/infinity-framework-vscode-tools

Next Steps...

You now have an app in a folder that's ready to be worked on. Next we'll look at running the app and seeing what changes we can make.