# Amtech

## Last reviewed 
Tony Gayter - 2021-06-15 

## Dependencies 
See the following files for more details: 

- Node 10 should be used for installation and builds
- `package.json` (dev node dependencies)
- `/.env.example` (required global environmental vars and license key placeholders)

## Project architecture 
- Inherited project
- Dockerised Wordpress build.
- Storefront based theme

## Docker
- Docker files can be found in the `docker` folder
- PHP image is based on [TheCodingMachine's PHP images](https://github.com/thecodingmachine/docker-images-php)
- Persistent files (uploads / DB files) will be stored in `docker/persist`

## Local development environment setup 
- Pull down repo
- Populate `.env` file(s) based on `.env.example files`
- Run `npm run dd` to create required docker containers
- Follow build process to install dependencies and build site assets
- Visit the local site and install temp Wordpress database following WP install process
- Use WP Migrate to pull down database and assets from live / stage 

## Build process:
- Run NVM USE to make sure your running the correct Node version
- Build dependencies are installed with `npm install`
- CSS / JS assets are built with `grunt` in teh src folder

## Deployment process: 
- Deployment currently handled by Deploy HQ
- Pushing to `master` branch will deploy to staging environment

## Project specific notes / issues 

