Projects

Projects are the main working areas within the <form.io> platform used by developers to build the <form.io> major components that will ultimately be implemented within their own customer Applications. The <form.io> system enables developers to easily build a service for their iOS, Android, Windows apps, and websites that all interact with the same <form.io> major components.

Each Project is typically associated with a single corresponding customer Application.

When a developer begins work within the <form.io> platform, they typically begin by creating a Project. Each Project will contain all of the major components for the customer Application such as Forms, Resources, Roles, etc.

Creating New Projects

New Projects can be created from the User Portal home page. To get there from any part of the portal, Click “Projects” in the header.

At the top will be a blue banner that contains the buttons to create a project. You can either create a custom project or use an application template.

When choosing an application template, the project is immediately created and ready for editing and previewing. The title and description of the newly created project may be changed by going to the project settings on the left.

When creating a custom application, you will be presented with the options for creating a project.

Project Title

The Project Title is the name that will be used to identify and access a specific Project throughout the entire life of the Project. Keeping this in mind, a sensible Project naming convention should be utilized to clearly identify the Project as being associated with the corresponding customer Application in which it will be used.

Description

The Project Description can be up to 512 characters and may be comprised of any letters, numbers, spaces, or other special characters. This description is simply used for reference within the Project, and is not utilized elsewhere.

When done, click Create Project and your new project will be created.

Project Template

Project Templates are predefined templates that specify what Resources, Forms, and Actions to automatically create for you. You may select from one of our existing project templates, or upload your own. Templates can be created by exporting an existing project. For more information on templates, see the Project Templates section.

Project Dashboard

The Project Dashboard page shows users an overview of the Projects core elements, analytics, and information.

1 project overview

Here users can see their Project Title, the Current Plan their Project is on, the amount of Submission Requests the Project has accumulated for the current month, the Project’s API Endpoint, all Roles, Forms, and Resources used within the Project, any Teams that may be assigned to this Project, and a Submission Activity graph showing submission requests for the year, month, or day.

2 project overview - submission

Project Settings

Users can configure the settings for their Projects by clicking the Settings tab within the Project at the top right of the page. The Project settings are used to configure Actions. Project settings currently include:

  • General Settings
    • Here you can change the Title, Description of the Project, and CORS options.
    • Note: Be careful when changing the subdomain, as it will change the base path of all APIs for your project. Only do this if you really know what you are doing.
    • CORS
    • CORS Note: Here you can control which domains have access to make requests to your API. This setting will be sent with all API requests in the Access-Control-Allow-Origin header.
    • You can also export and delete a project from this page. Templates can be used to create a new project. See the Project Templates section for more info.
  • Roles (see the Roles & Permissions chapter separately)
  • OAuth
    • Here you can enter your Client ID and Client Secret for the OAuth provider of your choice. These will be used in the OAuth Action
  • Email Providers
    • Here you have the flexibility to use your existing email provider to manage your communications. Enter the email credentials for the email provider of your choice and click Save Settings when done. See the Email Action on how to use these email providers.
  • File Storage
    • Form.io does not store files for your applications. If your forms contain a file component, you will need to set up where those files get stored.
  • Data Connections
    • The Data Connections allow you to configure various integrations and their settings.
      • Databases
        • Here you can provide credentials to your Microsoft SQL Server or MySQL databases to be used with SQL Actions.
      • Office 365 (Settings to integrate with Outlook and other 365 applications, see Office 365 Integration Guide)
      • Hubspot
      • Atlassian
      • SQL Connector
        • Here you can enter the credentials for your formio-sql instance.