https://github.com/strata/strata-website
https://github.com/strata/strata-website
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/strata/strata-website
- Owner: strata
- License: other
- Created: 2021-03-28T20:49:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T17:30:41.000Z (over 2 years ago)
- Last Synced: 2024-01-03T18:26:10.310Z (over 2 years ago)
- Language: PHP
- Size: 521 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Client Site name
WordPress website for Site name. Hosted on AWS Single Cloud 1.
## Getting started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for how to deploy the project to staging and live environments.
Also see more [detailed project documentation](docs/README.md) and the [project license](LICENSE.md).
### In this document
* [Site URLs](#site-urls)
* [Installing](#installing)
* [Deployment](#deployment)
* [Syncing tasks](#syncing-tasks)
* [Built with](#built-with)
* [Credits](#credits)
## Site URLs
### Live
* https://www.strata.dev
* https://www.strata.dev/_build_summary.json
### Staging
* https://staging.strata.dev
* https://staging.strata.dev/_build_summary.json
### Development
* https://local.strata.dev
## Installing
### Requirements
- PHP 7.4
- Node v12.16.0
- [NPM](https://www.npmjs.com/)
- [NVM](https://github.com/creationix/nvm)
- [Composer](https://getcomposer.org/)
- [Deployer](https://deployer.org/docs/installation)
### Installing locally
A step-by-step set of instructions that tell you how to get your local development environment running.
Clone repo:
````bash
git clone git@github.com:strata/strata_website.git
````
Install PHP dependencies:
```php
composer install
```
Install project dependencies:
````bash
# Switch your version of Node to the correct version for this project (see `.nvmrc`)
nvm use
cd web/wp-content/themes/example
npm install
````
Build assets:
````bash
cd web/wp-content/themes/example
npm build
````
Watch for changes:
````bash
cd web/wp-content/themes/example
npm watch
````
### Configuration
Any details on configuration files required.
## Making changes
To make changes to code first work on a branch and create a Pull Request to merge changes into the `main` branch.
All changes to the `main` branch need to pass continuous integration tests (PHP linting, PHP code standards).
See [workflow](.github/workflows/README.md) for more.
## Deployment
The site uses Deployer for deployment (installed via Composer). Please note if no branch is specified your current branch is used.
### Deploy to Live
You should always deploy the `main` branch to production.
````
./vendor/bin/dep deploy production --branch=main
````
### Deploy to Staging
Before deployment please check the [currently deployed branch](https://staging.example.com/_build_summary.json)
````
./vendor/bin/dep deploy staging --branch=branch-name-to-deploy
````
## Syncing tasks
Sync files from production or staging to your local development environment. These are setup in the `deploy.php` script,
see the [sync](https://github.com/studio24/deployer-recipes/blob/main/docs/sync.md) task for more.
#### Sync assets: Live → Local development
````bash
./vendor/bin/dep sync production --files=images
````
#### Sync assets: Staging → Local development
````bash
./vendor/bin/dep sync staging --files=images
````
## Built with
- [Apollo 2](https://apollo.studio24.net/) - Front-end starter kit
## Credits
- **Alan Isaacson** - *Support Developer* - Studio 24
- **Simon Jones** - *Managing Director* - Studio 24