bcdo/project

This package is abandoned and no longer maintained. No replacement package was suggested.

A scaffolding for projects

2.5.4 2020-10-09 11:51 UTC

Requires

• craftcms/aws-s3: ^1.2.8
• craftcms/cms: ^3.5.8
• nystudio107/craft-fastcgicachebust: ^1.0.0
• nystudio107/craft-imageoptimize: ^1.0.0
• nystudio107/craft-minify: ^1.2.5
• nystudio107/craft-retour: ^3.0.0
• nystudio107/craft-seomatic: ^3.2.0
• nystudio107/craft-twigpack: ^1.1.0
• nystudio107/craft-typogrify: ^1.1.4
• nystudio107/craft-webperf: ^1.0.0
• ostark/craft-async-queue: ^2.1.1
• vlucas/phpdotenv: ^3.4.0
• yiisoft/yii2-redis: ^2.0.6

Requires (Dev)

• yiisoft/yii2-shell: ^2.0.3

MIT

README

This is no longer maintained, and is adviced to not be used. The new nitro and nitro versions coming will all be docker based. This repo was a workaround to get up and running on the nitro multipass solution. Now, there will be no need if nitro is the preferred dev enviroment.

NOEN Reklamebyrå scaffolding

What is this?

This is a Craft CMS scaffolding project based on the nystudio107´s docker scaffolding. I needed it to work with vm instead of docker, so I have adjusted it to be used with Craft Nitro. Before trying to use this, make sure you install Nitro first. I will keep updating this project based on my own preferences, as well as follow ups on nystudio107´s updates.

Required Technology Stack

• Craft Nitro
• PHP 7.4

Build instructions

1. From developer folder, run "composer create-project bcdo/project project_name"

2. Add the site to Nitro, with "nitro add". If needed, start a new nitro machine with "nitro init -m machineName" first. If new machine was created all of the following nitro commands has to end with "-m nameOfMachine". For new machines, ssh into machine and run "sudo apt install composer -y && sudo apt install npm -y" then "sudo apt-get update -y && sudo apt-get install -y".

3. Exit the vm and duplicate the .env.example into .env file, and replace all the REPLACE_ME parts. To get the IP run nitro info. Remember the name of the database for the next step.

4. Cd into the scripts folder. Run "nitro db import seed_db.sql", and name it the same as in the .env file. This will seed the db properly.

5. Nitro ssh and Cd into the root folder, and run "composer install --no-scripts --optimize-autoloader --no-interaction", and "npm install". When finished run "npm run debug" in a new terminal - Check if everything compiles properly and keep it running in the background.

6. Exit the vm again and run "nitro db restart".

7. Nitro ssh into the machine and run "./craft setup" from root folder, and follow the instructions. To finish off, you can also run "composer update".

Thats it! Further down you will find optional installs as well, but not required.

To log in to craft, use the following admin details: User: [e-mail] Password: letmein

The database uses the Nitro default details.

In the future, will have to work on making it even less complicated.

Optional

Asset handling

1. Set up aws and cloudfront as explained at https://bit.ly/3g2ZcX8 , and populate the .env file accordingly. Remember the correct region, I use Stockholm which gives me the region of eu-north-1.
2. Set up a image transform service for serverless image handling as explained at https://bit.ly/2ZYx9Cr
3. Populate the .env file.

Pagetesting

1. The webperf plugin gives you an optional to input a webpagetest api. Head over to webpagetest.org, get the free api key and populate the .env file.

DB and Asset sync, and other scripts.

1. In the scripts directory, duplicate the example.env.sh file, and rename it to .env.sh.
2. Edit the .env.sh files and replace REPLAC_ME with appropriate information.
3. Create the .env.sh files for each environment, as this is ignored by git. Visit https://bit.ly/39xx4bW to understand the content of the scripts folder.

Pre-commit checklist

1. Follow https://bit.ly/2P0Gtzg to set up a custom pre-commit checklist for safe git commit, project based.