Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 3.03 KB

README.md

File metadata and controls

49 lines (28 loc) · 3.03 KB

medindex.co.uk

A single-page 'about Medindex' web site for marketing, intros, etc.

📦 Live deployment

The site is served via Cloudflare Pages, and integrated with this repository; changes to the live branch are automatically deployed to https://medindex.co.uk

💡 Changes to the live branch must be made via merging a pull request, not direct commits. PRs must be approved by a code owner before they can be merged.

🪟 Preview deployments

Commits pushed to branches other than live will generate preview deployments. Open a pull request against the live branch to see the preview URL displayed in the PR comments.

Preview deployments are gated by Cloudflare Access zero trust application access, you will need to be a member of the Medindex admins or collaborators teams to access the preview URL.

After validating the preview, merge the PR to deploy the changes to the live site.

🔧 Development

🧰 Requirements

⚡️ Quick start

$ git clone [email protected]:medindex-ltd/www-info-site.git
$ cd www-info-site
$ npm install
$ gulp

👩‍💻 Workflow

For local development, the default gulp task will generate the static files in output/ and start a local web server to preview the output at http://localhost:3000. Changes to the source files (in src/) will trigger a rebuild and reload the browser page.

🚀 Release builds

The release build configuration for the site uses a shell script as the build command, with output as the build directory. If you need to change the build command, you can edit shell script, build.sh, and/or the Gulp recipe file, gulpfile.js, accordingly. Fatal errors in the build script will cause the preview deployment to fail; verify the preview deployment succeeded following any changes, or roll back if necessary.

💡 Note that the build process will automatically run npm install to install any packages defined in package.json that are required for the build.

The Cloudflare documentation for build configurations describes the language support and tools available by default.

✒️ Design considerations

Cloudflare Pages is a lightweight Jamstack platform, there are a number of features and limitations to the architecture; see the Cloudflare documentation for further details.