Skip to content

Commit 3c8eb41

Browse files
smnandreweaverryan
authored andcommitted
[Site] Update README (importmap:install)
1 parent b07f864 commit 3c8eb41

File tree

5 files changed

+54
-116
lines changed

5 files changed

+54
-116
lines changed

ux.symfony.com/.symfony.local.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
workers:
2+
docker_compose: ~
3+
sass:
4+
cmd: ['symfony', 'console', 'sass:build', '--watch']

ux.symfony.com/README.md

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,63 @@
22

33
Source code for [ux.symfony.com](https://ux.symfony.com).
44

5-
## Contributing
5+
## Installation
66

7-
### Local Development
7+
### Source code
88

9-
1. Install the project:
10-
```bash
11-
git clone [email protected]:symfony/ux
12-
cd ux/ux.symfony.com/
13-
```
9+
Install the project:
10+
```bash
11+
git clone [email protected]:symfony/ux
12+
cd ux/ux.symfony.com/
13+
```
1414

15-
2. Install the dependencies:
16-
```bash
17-
symfony composer install
18-
```
15+
Install the dependencies:
16+
```bash
17+
symfony composer install
18+
```
1919

20-
3. (optional) Configure Docker:
21-
```bash
22-
docker compose up -d
23-
```
20+
### Services
2421

25-
5. Run database migrations:
26-
```bash
27-
symfony console doctrine:migration:migrate
28-
```
22+
(optional) Configure Docker to launch Mercure
23+
```bash
24+
docker compose up -d
25+
```
2926

30-
6. Populate the database:
31-
```bash
32-
symfony console app:load-data
33-
```
27+
### Database
3428

35-
7. Compile the Sass files:
36-
```bash
37-
symfony console sass:build --watch
38-
```
29+
Run database migrations:
30+
```bash
31+
symfony console doctrine:migration:migrate
32+
```
33+
34+
Populate the database:
35+
```bash
36+
symfony console app:load-data
37+
```
3938

40-
8. Start the web server:
41-
```bash
42-
symfony server:start -d
43-
```
39+
### Assets
4440

41+
Download the importmap packages locally:
42+
```bash
43+
symfony console importmap:install
44+
```
45+
46+
Compile the Sass files:
47+
```bash
48+
symfony console sass:build
49+
50+
# (optional) Add the --watch flag to automatically recompile the Sass files on change.
51+
symfony console sass:build --watch
52+
```
53+
54+
### Local server
55+
56+
Start the local web server (in background):
57+
```bash
58+
symfony server:start -d
59+
```
4560

46-
### Running the Test Suite
61+
## Testing
4762

4863
```bash
4964
symfony php bin/phpunit

ux.symfony.com/composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@
8787
"symfony/polyfill-php72": "*",
8888
"symfony/polyfill-php73": "*",
8989
"symfony/polyfill-php74": "*",
90-
"symfony/polyfill-php80": "*"
90+
"symfony/polyfill-php80": "*",
91+
"symfony/polyfill-php81": "*"
9192
},
9293
"scripts": {
9394
"auto-scripts": {

ux.symfony.com/composer.lock

Lines changed: 1 addition & 80 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

ux.symfony.com/symfony.lock

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -452,9 +452,6 @@
452452
"symfony/polyfill-mbstring": {
453453
"version": "v1.25.0"
454454
},
455-
"symfony/polyfill-php81": {
456-
"version": "v1.25.0"
457-
},
458455
"symfony/property-access": {
459456
"version": "v6.0.7"
460457
},

0 commit comments

Comments
 (0)