For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/tutorials-app-development-build.md.
  • 🇬🇧 English

    • Build your app with an external repository

    Here, you will learn how to set-up a React application and run it locally

    Objective

    Here, you will learn how to set-up a React application and run it locally.

    By the end of this guide, you will be able to edit a Data Platform application by running it locally, connecting it to the Platform' ecosystem and deploying it with a git repository.

    Requirements

    There are a few things you need before starting :

    Info

    The point of communication between your Data Platform Project and your app, is the Data Platform API that you exposed in Application Services. That is why it is required to complete the Getting Started guide until the part where you expose your data and queries on the API.

    Set-up an application & connect it to Data Platform

    Create an app using an existing template

    Clone this repository and open it:

    git clone https://github.com/forepaas/getting-started.git
cd getting-started/

    Switch to the branch release/basic

    git checkout release/basic

    Before installing the Node modules, you'll need to ensure our map-related dependencies are configured for the current environment. Open your package.json file and add the following lines to your dependencies section, or update them if they already exist:

    	"dependencies": {
	    // ... other existing dependencies
	    "leaflet": "^1.6.0",
	    "react-leaflet": "^2.7.0",
	    "react-leaflet-markercluster": "^2.0.0"
	  },

    Install node modules :

    yarn
    Warning

    If you get an error concerning certificates when installing yarn, you should contact your IT department to solve the issue.

    Install npx (Skip this step if you have already installed it globaly):

    yarn global add npx

    Install the Platform modules

    npm run fppm i
    Warning

    If you run into problems installing the modules, it may be due to your NodeJS configurations. Uninstall and reinstall NodeJS to fix the issue.

    Warning

    If the issue persists, it could be due to NodeJS version compatibility. Install NodeJS v16.20.2 to fix the issue.

    Run your app :

    yarn start
    Info

    Open http://localhost:3333 to check your app. If you see no error but a blank screen, don't worry! You still need to adjust the app configuration before seeing the panels. The blank screen means your app is up & running.

    Connect a git repository to the platform (optional)

    To link a git repository to the platform, please follow this guide

    Info

    Now that you've learned how to create and launch your app, it's time to understand its architecture.

    Understand app architecture and configuration files

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.