Skip to content

Commit

Permalink
Merge branch 'release/1.4.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
ademers committed Apr 23, 2022
2 parents 7332629 + 61cc3a4 commit d964b2e
Show file tree
Hide file tree
Showing 28 changed files with 5,713 additions and 7,271 deletions.
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ A [Craft CMS](https://craftcms.com/) starter project by [Andrea DeMers](https://
## Craft CMS Plugins

- [Contact Form](https://plugins.craftcms.com/contact-form)
- `fromName` field set to *required* via a custom Site Module
- [Minify](https://plugins.craftcms.com/minify)
- [Redactor](https://plugins.craftcms.com/redactor)
- [Retcon](https://plugins.craftcms.com/retcon)
Expand Down Expand Up @@ -42,37 +43,40 @@ A [Craft CMS](https://craftcms.com/) starter project by [Andrea DeMers](https://

## Requirements

- Craft [server requirements](https://docs.craftcms.com/v3/requirements.html)
- Craft [control panel browser requirements](https://docs.craftcms.com/v3/requirements.html#control-panel-browser-requirements)
- Craft CMS [server requirements](https://docs.craftcms.com/v3/requirements.html)
- Craft CMS [control panel browser requirements](https://docs.craftcms.com/v3/requirements.html#control-panel-browser-requirements)
- [Composer](https://getcomposer.org/) PHP dependency manager 1.3.0 or later

## Local Dev

This Craft Starter project is configured to use Craft Nitro 2.x as the local development environment.

- [Craft Nitro 2.x](https://craftcms.com/docs/nitro/2.x/)
- [Craft Nitro 2.x Mailhog](https://craftcms.com/docs/nitro/2.x/services/mailhog.html) for email.
- [Craft Nitro 2.x Redis](https://craftcms.com/docs/nitro/2.x/services/redis.html) for caching.
- PHP 8.0.16 for future compatibility with Craft 4. See [Upgrading from Craft 3](https://craftcms.com/docs/4.x/upgrade.html) docs
- MySQL 5.7.33. (May change to 8.x in near future)
- [Craft Nitro 2.x Mailhog](https://craftcms.com/docs/nitro/2.x/services/mailhog.html) for email
- [Craft Nitro 2.x Redis](https://craftcms.com/docs/nitro/2.x/services/redis.html) for caching

## Installation

1. To create a new project, run `composer create-project ademers/craft-starter <Path>`, substituting `<Path>` with the path where Composer should create the project.
2. Create a database as per the instructions in the [Craft documentation](https://docs.craftcms.com/v3/installation.html#step-4-create-a-database).
3. Set up your web server as per the instructions in the [Craft documentation](https://docs.craftcms.com/v3/installation.html#step-5-set-up-the-web-server).
4. Duplicate the `.env.example` file in the project root and rename it to `.env`.
5. Run the Craft setup wizard `./craft setup` and answer the questions when prompted.
6. Access your new Craft website from your web browser.
7. Do a little dance. :dancer:
1. To create a new project, run `composer create-project ademers/craft-starter <Path>`, substituting `<Path>` with the path where Composer should create the project
2. Create a database as per the instructions in the [Craft documentation](https://docs.craftcms.com/v3/installation.html#step-4-create-a-database)
3. Set up your web server as per the instructions in the [Craft documentation](https://docs.craftcms.com/v3/installation.html#step-5-set-up-the-web-server)
4. Duplicate the `.env.example` file in the project root and rename it to `.env`
5. Run the Craft setup wizard `./craft setup` and answer the questions when prompted
6. Access your new Craft website from your web browser
7. Do a little dance :dancer:

## Todo

- [ ] Get [Vite critical CSS](https://github.com/nystudio107/rollup-plugin-critical) working with Craft Nitro.
- [ ] Get [Vite Favicon generation](https://github.com/khalwat/vite-plugin-favicon) working with Craft Nitro.
- [ ] Add a Craft custom site module.
- [ ] Update installation instructions to include Nitro & Packagist versions.
- [x] Replace Vue.js with Alpine.js as default JavaScript framework.
- [x] Add installation instructions.
- [ ] Prep for Craft 4.
- [ ] Get [Vite critical CSS](https://github.com/nystudio107/rollup-plugin-critical) working with Craft Nitro
- [x] Get [Vite Favicon generation](https://github.com/khalwat/vite-plugin-favicon) working with Craft Nitro
- [x] Add a Craft custom site module as per [Enhancing a Craft CMS 3 Website with a Custom Module](https://nystudio107.com/blog/enhancing-a-craft-cms-3-website-with-a-custom-module) article
- [ ] Update installation instructions to include Nitro & Packagist versions
- [x] Replace Vue.js with Alpine.js as default JavaScript framework
- [x] Add installation instructions

## License

The MIT License (MIT). Please see [License file](https://github.com/ademers/craft-starter/blob/develop/LICENSE.md) for more information.
The MIT License (MIT). Please see [License file](https://github.com/ademers/craft-starter/blob/develop/LICENSE.md) for more information
93 changes: 49 additions & 44 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,47 +1,52 @@
{
"name": "ademers/craft-starter",
"description": "A Craft CMS starter project by Andrea DeMers.",
"keywords": [
"craft",
"cms",
"craftcms",
"project"
],
"type": "project",
"version": "1.3.0",
"license": "MIT",
"require": {
"craftcms/cms": "3.7.34",
"craftcms/contact-form": "2.3.0",
"craftcms/redactor": "2.10.5",
"mmikkel/retcon": "2.3.0",
"nystudio107/craft-minify": "1.2.11",
"nystudio107/craft-scripts": "1.2.10",
"nystudio107/craft-seomatic": "3.4.26",
"nystudio107/craft-vite": "1.0.23",
"putyourlightson/craft-sprig": "1.12.0",
"vlucas/phpdotenv": "^3.4.0",
"yiisoft/yii2-redis": "^2.0"
},
"autoload": {
"psr-4": {
"modules\\": "modules/"
}
},
"config": {
"sort-packages": true,
"optimize-autoloader": true,
"platform": {
"php": "7.2.5"
}
},
"scripts": {
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
"name": "ademers/craft-starter",
"description": "A Craft CMS starter project by Andrea DeMers.",
"keywords": [
"craft",
"cms",
"craftcms",
"project"
],
"post-create-project-cmd": [
"@composer dump-autoload -o",
"@php craft setup/welcome"
]
}
"type": "project",
"version": "1.4.1",
"license": "MIT",
"require": {
"craftcms/cms": "3.7.38",
"craftcms/contact-form": "2.5.0",
"craftcms/redactor": "2.10.6",
"mmikkel/retcon": "2.4.1",
"nystudio107/craft-minify": "1.2.11",
"nystudio107/craft-scripts": "1.2.10",
"nystudio107/craft-seomatic": "3.4.30",
"nystudio107/craft-vite": "1.0.24",
"putyourlightson/craft-sprig": "1.12.4",
"vlucas/phpdotenv": "^3.4.0",
"yiisoft/yii2-redis": "^2.0"
},
"autoload": {
"psr-4": {
"modules\\": "modules/",
"modules\\sitemodule\\": "modules/sitemodule/src/"
}
},
"config": {
"sort-packages": true,
"optimize-autoloader": true,
"platform": {
"php": "8.0.16"
},
"allow-plugins": {
"craftcms/plugin-installer": true,
"yiisoft/yii2-composer": true
}
},
"scripts": {
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
],
"post-create-project-cmd": [
"@composer dump-autoload -o",
"@php craft setup/welcome"
]
}
}
Loading

0 comments on commit d964b2e

Please sign in to comment.