Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Maintenance] Cleanup and installation guide update #439

Merged
merged 2 commits into from
Dec 4, 2024
Merged

[Maintenance] Cleanup and installation guide update #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef41ba7
Remove leftover `psalm` references in the makefile
NoResponseMate Dec 4, 2024
51f9a09
Update traditional installation section in readme
NoResponseMate Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ frontend:

init: install backend frontend

ci: init phpstan psalm phpunit phpspec behat
ci: init phpstan phpunit phpspec behat

integration: init phpunit behat

static: install phpspec phpstan psalm
static: install phpspec phpstan
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,33 @@ there you will find the <a href="https://docs.sylius.com/en/latest/plugin-develo

## Quickstart Installation

### Traditional
Run `composer create-project sylius/plugin-skeleton ProjectName`.

1. Run `composer create-project sylius/plugin-skeleton ProjectName`.
### Traditional

2. From the plugin skeleton root directory, run the following commands:
1. From the plugin skeleton root directory, run the following commands:

```bash
$ (cd tests/Application && yarn install)
$ (cd tests/Application && yarn build)
$ (cd tests/Application && APP_ENV=test bin/console assets:install public)

$ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
$ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)
# Optionally load data fixtures
$ (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load --no-interaction)
```

To be able to set up a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`.
To be able to set up a plugin's database, remember to configure your database credentials in `tests/Application/.env` and `tests/Application/.env.test`.

2. Run your local server:

```bash
symfony server:ca:install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this necessary for the local app? 🤔

APP_ENV=test symfony server:start --dir=tests/Application/public --daemon
```

3. Open your browser and navigate to `https://localhost:8000`.

### Docker

Expand Down
Loading