Merge branch 'main' into no-task/add-datetime-components-with-hook-fo…

…rm-integration

README.md

@@ -9,6 +9,68 @@ Currently, four official plugins are available:
 - [@sentry/react](https://docs.sentry.io/platforms/javascript/guides/react/) providing React-specific error boundaries and hooks for monitoring exceptions and performance issues.
 - [@sentry/vite-plugin](https://docs.sentry.io/platforms/javascript/guides/react/sourcemaps/uploading/vite/) automates source map uploading for Vite-based projects, enhancing Sentry's debugging capabilities with meaningful error information.
 
+
+## Create a brand new project from boilerplate
+
+To facilitate the creation of new projects from this boilerplate, you can define the following function in the shell initialization file
+
+```
+cat << __EOF__ >> ~/.zshrc
+create_fe_project() {
+   # Clone the boilerplate repository
+   git clone [email protected]:Light-it-labs/fe-boilerplate.git "\$@"
+   # Change to the newly created directory
+   cd "\$@"
+   # Remove the boilerplate change history
+   rm -fr .git
+   # Create a new GIT repository
+   git init
+   # Install the defined version of NodeJS
+   nvm install
+   # Change the project name
+   npm pkg set name="\$@"
+   # Add all files to commit
+   git add --all
+   # Create the initial commit
+   git commit -m "initial project setup from fe-boilerplate"
+}
+__EOF__
+```
+
+Then run the following command to create a new project
+
+```
+create_fe_project my-awesome-project
+```
+
+## Setup a already created project from this boilerplate
+
+After cloning a project created by this boilerplate, make sure to follow the steps below
+
+1. Setup the correct NodeJS version
+
+```bash
+nvm install
+```
+
+2. Ensure you have corepack enabled
+
+```bash
+corepack enable
+```
+
+3. Install project dependencies
+
+```bash
+pnpm install
+```
+
+4. Run the development server
+
+```bash
+pnpm dev
+```
+
 ## Sentry
 
 Sentry is a developer-first error tracking and performance monitoring platform. Errors are logged both from the frontend and backend. In order to get it up and running, you need to follow these steps:

package.json

@@ -125,5 +125,6 @@
     "src/**/*.{js,jsx,ts,tsx}": [
       "pretty-quick --staged"
     ]
-  }
+  },
+  "packageManager": "[email protected]+sha512.cce0f9de9c5a7c95bef944169cc5dfe8741abfb145078c0d508b868056848a87c81e626246cb60967cbd7fd29a6c062ef73ff840d96b3c86c40ac92cf4a813ee"
 }