SimonFrings / framework-x-website

Framework X website

Framework X website

Source code for the Framework X website.

Build

You can build the website like this:

$ make

Note that this command will clone Framework X which is currently in early access. See https://github.com/clue/framework-x for more details.

If you've pulled Framework X before and want to update its source code, you can pull an up-to-date version and rebuild the website like this:

$ make pull
$ make

Once built, you can manually browse the build/ directory or run the web server container (Apache) in the foreground like this:

$ make serve

Alternatively, you may also run the web server container (Apache) as a background daemon like this:

$ make served

Once running, you can run some integration tests that check correct paths etc. like this:

$ make test

Once done, you can clean up like this:

$ make clean

Deploy

Once built (see previous "Build" section), you can simply deploy the build/ directory behind Apache.

The live website is deployed by pushing the contents of the build/ directory to the live branch like this:

$ make deploy

Auto-Deployment

The website can be automatically deployed via the GitHub Pages feature.

Any time a commit is merged (such as when a PR is merged), GitHub actions will automatically build and deploy the website. This is done by running the above deployment script (see previous chapter).

Repository setup: Note that this command will clone Framework X which is currently in early access. We're using a read-only SSH deploy key for reading from this source repository. Make sure the required DEPLOY_KEY secret is set in the repository settings on GitHub. See action documentation for more details.