Skip to content

Commit

Permalink
Merge branch 'release/3.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
terryupton committed Oct 21, 2020
2 parents 4c902b2 + 0cf388f commit 88dd7b3
Show file tree
Hide file tree
Showing 70 changed files with 2,520 additions and 1,020 deletions.
4 changes: 3 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Craft general settings
################################################
SECURITY_KEY=""
APP_ID=""
ENVIRONMENT="local"

ALLOW_UPDATES=1
Expand All @@ -13,6 +14,7 @@ IS_SYSTEM_LIVE=1
MAX_REVISIONS=10
RUN_QUEUE_AUTOMATICALLY=1
TEST_TO_EMAIL_ADDRESS=""
DISALLOW_ROBOTS=1

################################################
# Craft database settings
Expand All @@ -30,7 +32,7 @@ DB_PORT="3306"
# Site Settings
################################################
# Site Url - the url that is used to access the site on the environmental platform
DEFAULT_SITE_URL="REPLACE_ME"
PRIMARY_SITE_URL="REPLACE_ME"

# The base path of the cms uploads folder - this is used in @aliases in the general config.
ASSETS_PATH="/uploads"
Expand Down
74 changes: 74 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,80 @@
# Changelog
All notable changes to this project will be documented in this file.

## [3.0.0] - 2020-10-20
### Added
- Image Optimize Plugin
- Sync script to run pull_db and pull_assets together in one script
- Added Field Manager JSON fields for contact fields
- Building Name
- Address Line 1
- Address Line 2
- City/Town
- County
- Post Code
- Email
- Telephone
- Added Field Manager JSON fields for social media fields
- Facebook
- Instagram
- LinkedIn
- Twitter
- YouTube
- Added Field Manager JSON fields for legal fields
- Full Company Name
- Company Number
- VAT Number
- Added Field Manager JSON fields for terms fields
- Terms
- Added Field Manager JSON fields for teaser fields
- Teaser Image
- Teaser Body
- Teaser Heading
- Added Field Manager JSON fields for assets fields
- Alt
- Notes
- Stock/Source Url
- Display Title
- Added Field Manager JSON fields for image optimisation fields
- Srcset 8x5

Config Files
- Image Optimization Config File

### Changed
- Update to the Latest Composer Package Versions
- Update to the Latest NPM Dependencies
- Updated and Migrated to New Project Yaml Setup as per Craft 3.5
- Fixed Common_mysql to allow for funny characters in db passwords
- Update post- README file for new projects
- Swapped general settings to use Environmental Vars where applicable
- Update to .env example
- Add app ID Setting(craft 3.5)
- Add Disallow Robots Setting (craft 3.5)
- Swapped to DEFAULT_SITE_URL to PRIMARY_SITE_URL (as per Craft default)
- Set users profile image asset folder
- Setting better Tailwind Defaults
- Opacity
- Zindex
- Spacing
- Margin (flood/full width)
- CSS Grid Auto Cols
- CSS Grid (cols/rows) -1
- Screensizes
- File colours
- Min Width
- Variants

### Removed
Plugins Removed
- Imager Plugin (no longer supported)
- Retcon Plugin (possibly not required now tailwind offers typography plugin)
- Typed Link Field Plugin (not required for all projects as standard)
- CP Field Inspect Plugin (now native)
- Relabel Plugin (now native)
Config Files
- Image Config File


## [2.2.0] - 2020-03-29
### Added
Expand Down
28 changes: 19 additions & 9 deletions README.md.default
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,34 @@ Icons



Config and Setup
Further Config and Setup
----------

1. To create a new project, run composer create-project terryupton/boilerplate-craft <Path>, substituting <Path> with the path where Composer should create the project.

2. Update a .env file adding the database connections and other settings

3. Run ./craft setup and follow the instructions
1. Setup website locally in Valet
- valet link domain
- valet secure

4. Set up a node_modules symlink
2. Set up a node_modules symlink
- create new node_modules folder under /Users/terryupton/node_modules_local/domain.ext
- add symlink to node_modules folder: ln -s ~/node_modules_local/domain.ext/node_modules

3. Install Node Modules
- run yarn install

4. Set up Git Repository

5. Create tailwind.full.js file for easy reference.
- npx tailwindcss init tailwindcss.full.js


Craft Setup
- npx tailwindcss init tailwind.full.js --full

6. Update settings.json

5. Proceed with Craft Setup and Config



Craft Setup and Config
----------
Updates to run inside Craft
1. General > System Name
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "terryupton/boilerplate-craft",
"description": "A starting boilerplate for Craft Projects",
"version": "2.2.0",
"version": "3.0.0",
"license": "MIT",
"type": "project",
"require": {
Expand Down
91 changes: 91 additions & 0 deletions config/field-manager-default-fields/asset-fields.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
[
{
"name": "Alt",
"handle": "alt",
"instructions": "Alt text (alternative text) is a word or phrase that can be inserted as an attribute to tell Web site viewers the nature or contents of an image. The alt text appears in the code and is good for SEO, Accessibility and is a best practice to include this field. If no Alt Text is specified then the title of the image will be used instead. In some instances Alt text will be autogenerated, an example being Logo assets. \r\n\r\nAlt text should ideally describe the image but would benefit from any keywords. E.g Stack of blueberry pancakes with powdered sugar",
"required": null,
"searchable": 1,
"translationMethod": "none",
"translationKeyFormat": null,
"type": "craft\\fields\\PlainText",
"settings": {
"uiMode": "normal",
"placeholder": "Please enter an image description | e.g Stack of blueberry pancakes with powdered sugar",
"code": "",
"multiline": 1,
"initialRows": 4,
"charLimit": null,
"byteLimit": null,
"columnType": "text"
}
},
{
"name": "Display Title",
"handle": "displayTitle",
"instructions": "This is used for documents and files and will use this title on the website for downloads\/links to documents.",
"required": null,
"searchable": 0,
"translationMethod": "none",
"translationKeyFormat": null,
"type": "craft\\fields\\PlainText",
"settings": {
"uiMode": "normal",
"placeholder": "",
"code": "",
"multiline": "",
"initialRows": 4,
"charLimit": null,
"byteLimit": null,
"columnType": null
}
},
{
"name": "Notes",
"handle": "notes",
"instructions": "Use this field to enter any additional notes regarding the image.",
"required": null,
"searchable": 1,
"translationMethod": "none",
"translationKeyFormat": null,
"type": "craft\\redactor\\Field",
"settings": {
"uiMode": "enlarged",
"redactorConfig": "Simple.json",
"purifierConfig": "",
"cleanupHtml": true,
"removeInlineStyles": 1,
"removeEmptyTags": 1,
"removeNbsp": 1,
"purifyHtml": 1,
"columnType": "text",
"availableVolumes": "*",
"availableTransforms": "*",
"showUnpermittedVolumes": false,
"showUnpermittedFiles": false,
"showHtmlButtonForNonAdmins": true,
"configSelectionMode": "choose",
"manualConfig": "",
"defaultTransform": ""
}
},
{
"name": "Stock\/Source Url",
"handle": "stockSoruceUrl",
"instructions": "Use this field to paste the URL for the original stock\/source image. This could be useful to reference Stock images.",
"required": null,
"searchable": 1,
"translationMethod": "none",
"translationKeyFormat": null,
"type": "craft\\fields\\PlainText",
"settings": {
"uiMode": "normal",
"placeholder": "",
"code": false,
"multiline": "",
"initialRows": 4,
"charLimit": null,
"byteLimit": null,
"columnType": "text"
}
}
]
Loading

0 comments on commit 88dd7b3

Please sign in to comment.