From 464bca11c9e09a1d45acbc31df47e4e8a8d0fc9e Mon Sep 17 00:00:00 2001 From: Hugues Tavernier Date: Fri, 3 Nov 2023 09:40:41 +0100 Subject: [PATCH] update readme --- .github/ISSUE_TEMPLATE/config.yaml | 10 ++++--- README.md | 42 +++++++++++++----------------- src/vite-bundle/README.md | 3 ++- src/vite-plugin-symfony/README.md | 2 ++ 4 files changed, 28 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index ca4e5c73..33c76d52 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1,6 +1,8 @@ blank_issues_enabled: true contact_links: - - name: vite-bundle Issue/Feature request. - url: https://github.com/lhapaipai/vite-bundle/issues - - name: vite-plugin-symfony Issue/Feature request. - url: https://github.com/lhapaipai/vite-plugin-symfony/issues + - name: vite-bundle Issue/Feature request. + url: https://github.com/lhapaipai/vite-bundle/issues + about: Please ask and answer questions about vite-bundle here. + - name: vite-plugin-symfony Issue/Feature request. + url: https://github.com/lhapaipai/vite-plugin-symfony/issues + about: Please ask and answer questions about vite-plugin-symfony here. \ No newline at end of file diff --git a/README.md b/README.md index 6234115a..5d131403 100644 --- a/README.md +++ b/README.md @@ -4,47 +4,41 @@ # Symfony Vite Development Repository +In this repository you can contribute to `pentatrion/vite-bundle` et `vite-plugin-symfony`. You can find playgrounds for development. + ## Installation ```bash git clone https://github.com/lhapaipai/symfony-vite-dev.git cd symfony-vite-dev -git submodule init -git submodule update -# install vite-plugin-symfony locally -# go to the folder /extra/vite-plugin-symfony -cd extra/vite-plugin-symfony -npm i -npm run build -cd ../.. -# install dependencies common to all examples -# in the folder -npm install +## Install vite-bundle/vite-plugin-symfony dependencies +make install -# install composer dependencies for the `basic` example. -cd playground/basic -composer install -# launch the development environment for the `basic` example. -# always in the /playground/basic folder -npm run dev -symfony local:server:start +## Install playgrounds (npm i/composer i for each of them) +make install-playgrounds +``` +## Execution + +```bash +# launch the development environment for the `basic` playground. +cd playground/basic +symfony local:server:start +npm run dev # from your browser go to: https://127.0.0.1:8000/ ``` ## Ecosystem -| Package | Description | -| ----------------------------------------------------------------------- | :------------------------ | -| [vite-bundle](https://github.com/lhapaipai/vite-bundle) | Symfony Bundle | -| [vite-plugin-symfony](https://github.com/lhapaipai/vite-plugin-symfony) | Vite plugin | -| [symfony-vite-docs](https://github.com/lhapaipai/symfony-vite-docs) | Documentation | -| [symfony-vite-dev](https://github.com/lhapaipai/symfony-vite-dev) | Package for contributors | +| Package | Description | +| ----------------------------------------------------------------------- | :--------------------------- | +| [vite-bundle](https://github.com/lhapaipai/vite-bundle) | Symfony Bundle (subtree split) | +| [vite-plugin-symfony](https://github.com/lhapaipai/vite-plugin-symfony) | Vite plugin (subtree split) | ## License diff --git a/src/vite-bundle/README.md b/src/vite-bundle/README.md index 95bf7fa4..bab97d69 100644 --- a/src/vite-bundle/README.md +++ b/src/vite-bundle/README.md @@ -7,6 +7,8 @@ This bundle helping you render all of the dynamic `script` and `link` tags needed. Essentially, he provides two twig functions to load the correct scripts into your templates. +⚠️ This repository is a "subtree split": a read-only subset of that main repository [symfony-vite-dev](https://github.com/lhapaipai/symfony-vite-dev). + ## Installation Install the bundle with : @@ -45,7 +47,6 @@ Add this twig functions in any template or base layout where you need to include | ----------------------------------------------------------------------- | :------------------------ | | [vite-bundle](https://github.com/lhapaipai/vite-bundle) | Symfony Bundle | | [vite-plugin-symfony](https://github.com/lhapaipai/vite-plugin-symfony) | Vite plugin | -| [symfony-vite-docs](https://github.com/lhapaipai/symfony-vite-docs) | Documentation | | [symfony-vite-dev](https://github.com/lhapaipai/symfony-vite-dev) | Package for contributors | ## License diff --git a/src/vite-plugin-symfony/README.md b/src/vite-plugin-symfony/README.md index d786d0bf..bd8e837a 100644 --- a/src/vite-plugin-symfony/README.md +++ b/src/vite-plugin-symfony/README.md @@ -7,6 +7,8 @@ A Vite plugin to integrate easily Vite in your Symfony application.. This package is intended for use with the Symfony Bundle : [pentatrion/vite-bundle](https://github.com/lhapaipai/vite-bundle). +⚠️ This repository is a "subtree split": a read-only subset of that main repository [symfony-vite-dev](https://github.com/lhapaipai/symfony-vite-dev). + ## Installation ```console