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

Jump to bottom

[#14] Installs Starter Craft Plugins #19

Merged
merged 2 commits into from
May 24, 2024
Merged

[#14] Installs Starter Craft Plugins #19

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
f22a864
[#14] Installs the following plugins
joshuapease May 24, 2024
d22e9a7
[#14] Adds documentation about plugins.
joshuapease May 24, 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
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ Our starter uses DDEV for local development. Install it before doing any of the
cd my-project
```
3. Create The Project
If you already have PHP and Composer running on your host machine (your computer, not Docker container or DDEV instance), you can run the following command
If you already have PHP and Composer running on your host machine (your computer, not Docker container or DDEV
instance), you can run the following command

```shell
composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
```

If you'd rather not set up PHP, you can create the project with a desposable Docker image ([Thanks nystudio107](https://nystudio107.com/blog/dock-life-using-docker-for-all-the-things)).
If you'd rather not set up PHP, you can create the project with a desposable Docker
image ([Thanks nystudio107](https://nystudio107.com/blog/dock-life-using-docker-for-all-the-things)).

```shell
docker run --rm -it -v "$PWD":/app -v ${COMPOSER_HOME:-$HOME/.composer}:/tmp composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
Expand All @@ -33,6 +35,26 @@ Our starter uses DDEV for local development. Install it before doing any of the
```
5. Run `ddev launch` to open the project in your browser

# Plugins

This starter includes common plugins that we use on most of our sites. This provides consistency and familiarly between
client projects. You may not need every plugin, but avoid
replacing standard plugins with similar alternatives (unless absolutely necessary).

| Name | Composer | Usage | Year 1 Price | Renewal Price |
| ----------------------------------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------- |
| [Amazon S3](https://plugins.craftcms.com/aws-s3) | `craftcms/aws-s3` | This plugin integrates Craft CMS and Amazon S3 cloud storage service. | Free | Free |
| [Autocomplete](https://github.com/nystudio107/craft-autocomplete) | `nystudio107/craft-autocomplete` | Provides Twig template IDE autocomplete of Craft CMS & plugin variables. Requires the [PHPStorm Symphony Support Plugin](https://plugins.jetbrains.com/plugin/7219-symfony-support) | Free | Free |
| [CKEditor](https://plugins.craftcms.com/ckeditor) | `craftcms/ckeditor` | Craft CMS’s official rich text plugin | Free | Free |
| [Classnames](https://plugins.craftcms.com/classnames) | `viget/craft-classnames` | Conditionally join css class names together in Twig | Free | Free |
| [CP Field Inspect](https://plugins.craftcms.com/cp-field-inspect) | `mmikkel/cp-field-inspect` | CP Field Inspect is a tiny utility plugin, that makes content modelling a little bit easier in Craft. | Free | Free |
| [Empty Coalesce](https://plugins.craftcms.com/empty-coalesce) | `nystudio107/craft-emptycoalesce` | Adds the `???` operator to Twig that will return the first thing that is defined, not null, and not empty. | Free | Free |
| [Imager X](https://plugins.craftcms.com/imager-x) | `spacecatninja/imager-x` | Image optimization and Imgix connector. Provides useful Twig shortcuts for generating transforms and placeholders. | $99.00 | $59.00 |
| [Navigation](https://plugins.craftcms.com/navigation) | `verbb/navigation` | Simplifies management of complex navigation groups (main menus, footer menus, etc.) | $19.00 | $5.00 |
| [Retour](https://plugins.craftcms.com/retour) | `nystudio107/craft-retour` | Provides an Craft admin UI to set up redirects. Will automatically create redirects when URLs of entries change. | $59.00 | $29.00 |
| [SEOMatic](https://plugins.craftcms.com/seomatic) | `nystudio107/craft-seomatic` | A turnkey SEO plugin that follows [modern SEO best practices](https://nystudio107.com/blog/modern-seo-snake-oil-vs-substance). | $99.00 | $49.00 |
| [Vite](https://plugins.craftcms.com/vite) | `nystudio107/craft-vite` | Loads front-end files that are compiled by Vite. | Free | Free |

# Contribute to this starter

## Local Dev
Expand Down
10 changes: 10 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@
"minimum-stability": "dev",
"prefer-stable": true,
"require": {
"craftcms/aws-s3": "2.2.1",
"craftcms/ckeditor": "4.0.6",
"craftcms/cms": "^5.0.0",
"mmikkel/cp-field-inspect": "2.0.1",
"nystudio107/craft-emptycoalesce": "5.0.0",
"nystudio107/craft-retour": "5.0.0",
"nystudio107/craft-seomatic": "5.0.3",
"nystudio107/craft-vite": "^5.0.0",
"spacecatninja/imager-x": "5.0.0",
"verbb/navigation": "3.0.0",
"viget/craft-classnames": "3.0.0",
"vlucas/phpdotenv": "^5.4.0"
},
"require-dev": {
"craftcms/ecs": "dev-main",
"craftcms/generator": "^2.0.0",
"craftcms/phpstan": "dev-main",
"nystudio107/craft-autocomplete": "^1.12",
"yiisoft/yii2-shell": "^2.0.3"
},
"autoload": {
Expand Down
Loading