Skip to content

Commit

Permalink
Very simple readme
Browse files Browse the repository at this point in the history
  • Loading branch information
katzueno committed Jan 14, 2022
1 parent 37c928c commit d5b5c84
Showing 1 changed file with 13 additions and 47 deletions.
60 changes: 13 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,29 @@
# concrete5 Git Boiler Plate for client work
# Concrete CMS patch for Express Form to send Confirmation Email to Form Submitter

By @katzueno

This is basic git template for concrete5 site development by concrete5 Japan, Inc.
This is override of express form of Concrete CMS so that you can send an notification email to form submitter.

## Concept
This patch was tested with Concrete CMS 9.0.1

I'm in charge of setting up a new server and git repo for multiple projects.
## Files to override & copy to your Concrete CMS

It's troublesome to make initial git repo by hand. So I made this git repo.
Please copy the following files on this repo to your Concrete CMS.

Whenever there is a new concrete5 site project for a client, we can just simply copy and paste these files.
- application/blocks/express_form/controller.php
- application/bootstrap/autoload.php
- application/mail/block_express_form_submission_user.php
- application/src/Express/Entry/Notifier/Notification/FormBlockSubmissionEmailNotification.php

## Design
## Email Template

This repo ignores

- OS and file system files
- concrete5 core file
- concrete5 language files
- concrete5 File Manager files & cache
- concrete5 config
- generated_overrides
- main database.php
- Doctrine
- valet related config (Laravel's Mac OS local LNMP environment)
- Composer's vendor folde
- Sitemap.xml
- PHP Composer files
- Node files
- Major IDE System files
- PHP Storm
- Visual Studio Code

I welcome any PR and suggestion.
If you don't like ".gitkeep" files. You are welcome to remove them.

This repo has

- application/config/concrete.php
- Hide concrete5 version
- Email from addresses & name

**You must change** config setting accordingly.

### [ATTENTION] Composer Vendor file

I've added to ignore "vender" folders to git repo.

If you install the package with vendor folder, you must manage to run `composer install` or modify to include the vendor directories.

If you don't do anything with current gitignore, **you will get error** when you deploy the package with composer.json.
You can modify inside of `block_express_form_submission_user.php` to add some custom message.
If you want more dynamic processing, you may also need to modify `FormBlockSubmissionEmailNotification.php`

## LICENSE

MIT License.

## History

- 2020.8.24 Keep /composer.json & add vendor folder to gitignore
- 2020.4.17 Added Panic's Nova project files to gitignore
- 2019.2.20 Initial commit based on 8.4.4 & 8.5.0RC1
- 2022.1.14 Initial working patch

0 comments on commit d5b5c84

Please sign in to comment.