Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lhapaipai committed Nov 3, 2023
1 parent 5dd96d7 commit 464bca1
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 29 deletions.
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 18 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <project-dir>/extra/vite-plugin-symfony
cd extra/vite-plugin-symfony
npm i
npm run build
cd ../..

# install dependencies common to all examples
# in the <project-dir> 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 <project-dir>/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

Expand Down
3 changes: 2 additions & 1 deletion src/vite-bundle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 :
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/vite-plugin-symfony/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 464bca1

Please sign in to comment.