New pyronear platform

Local setup

1. Install nodejs

The node version is specified in ./.nvmrc file We strongly recommend to use a version manager to deal with node version, rather than downloading directly node (easier in case of updates)

Option A : fnm Use fnm to ensure you always use the correct node version:

curl -fsSL https://fnm.vercel.app/install | bash

Reload your terminal and go back to this folder. It should prompt you to download the correct Node version. If that's not the case, simply run fnm install (it download the version specified in the file ./.nvmrc ).

Option B : nvm See github repo to know how to install it Then execute

nvm use {NODE_VERSION}

2. Install pnpm

In this project we use pnpm rather the default package manager npm

Execute the following command:

npm install -g pnpm

3. Install project dependencies

Install all dependencies with pnpm:

pnpm install

It should create a /node_modulesdirectory

4. Configure .env file

You'll need a valid .env file to run this app properly.

• Duplicate the file .env.example and rename it .env.local
• Fill it with local parameters

Note to configure the parameter VITE_API_URL in .env.local file:

• Use an existing API (staging, or prod if you're brave)
• OR you can run the backend repo locally

Keep in mind to synchronize your .env.local file with .env.example : If new properties are added to the .env.example file, it must be also added to your file .env.local

5. Run the project !

You should now be able to run the website locally with

pnpm run dev

Once the setup is done, next time you want to run the app, you need to execute only the last step

Contributing

The code is formatted by prettier and eslint. Please download those extensions in your IDEA to enable automatic formatting on save.