Creating a New App

To create a new app, navigate to the admin portal.

Ensure you are in the Apps tab and click the Create App button.

App details

Enter your app's name and select a region. Your app will be created with a testing deployment, and the region specifies in which geographical region the deployment's data will be stored. Note that for each additional deployment you create in OXIDE you can specify its respective region.

Version Control

Next, select your preferred version control for your app.

JourneyApps provides a choice between Basic (Revisions) and Advanced (Git) source control options.

  • The Basic (Revisions) option is suitable for smaller apps with only one or two developers, where simple restore points for your code are sufficient. This option requires zero configuration from the developer and therefore is the most convenient option to manage smaller codebases.

  • The Advanced (Git) option is recommended for larger, more complex apps where a team of developers is involved - since this option will allow developers to work on different branches in OXIDE. When combined with a git provider such as GitHub (see next section), you can follow your existing DevOps practices and fully utilize git best practices.

Additionally, you can choose between JourneyApps and external providers such as GitHub and Azure Repos (currently in Beta) as your git provider. This dictates where your code repository is hosted.

  • The JourneyApps option means we host your repository. This option requires no additional configuration.

  • The GitHub and Azure Repos options allow you to host your app's code in your GitHub organization or Azure DevOps project respectively. This means you have access to you app's codebase outside of OXIDE. Combined with the Advanced (Git) source control option, developers can complete work using git best practices, including code reviews and methodologies like trunk-based development or git flow. With these external git providers, developers can also enforce security best practices on their application code using functionality such as branch protection to ensure that only authorized changes are deployed to production apps.

For further details about git-enabled apps and their setup, see this page:

pageGit-enabled Apps

Template

Finally, choose a template for your app:

The Blank option creates your app based off a blank JavaScript or TypeScript template. Choose this option if you want to build a brand new app and not base it off any existing apps or any published templates.

Try TypeScript!

There are many benefits to using TypeScript over JavaScript apps. TypeScript has better error and type-checking in OXIDE, you can include many NPM libraries in your app, and it is possible to build more modular apps that are more maintainable as they grow in scope and size.

The Template option allows you to choose from previously published apps, that solve use cases in specific industries or contexts. For example, here you can choose a "Warehouse Fulfillment" template - which provides some skeleton code and basic UI for typical warehouse fulfillment use cases.

The Clone an existing app option allows you to clone any other app in the organization. Select this option if you want to reuse the majority of code and UI from an existing app.

Click the "Create App" button to complete the creation process. This will launch your new app in OXIDE, where you can begin developing your app.

Last updated