i should not try to write text files at 5am

This commit is contained in:
Matteias Collet 2020-07-10 05:37:45 +02:00 committed by GitHub
parent f023df6a87
commit a213186db3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -27,8 +27,6 @@ You can find the guides in the [site](https://github.com/BitPatty/gctGenerator/t
Note that in the code reference files everything following the `<!-- injectionpoint -->` tag will be removed during the next build. Note that in the code reference files everything following the `<!-- injectionpoint -->` tag will be removed during the next build.
Before opening a PR make sure you run `yarn codes:clean` to remove the injected codes.
### Site Development ### Site Development
If you intend to change site code you need [NodeJS](https://nodejs.org/en/) version 12.18.1 or greater installed on your local. If you intend to change site code you need [NodeJS](https://nodejs.org/en/) version 12.18.1 or greater installed on your local.
@ -55,6 +53,8 @@ The XML codes will be written automatically to the json file and code reference
If you want to inject the codes at any given point you can use `yarn codes:inject`. If you want to inject the codes at any given point you can use `yarn codes:inject`.
Before opening a PR make sure you run `yarn codes:clean` to remove the injected codes.
### Build and preview the site (Docker) ### Build and preview the site (Docker)
The project root provides a [docker-compose](https://docs.docker.com/compose/) file, which creates a clean build (with the same configuration as the production build) and spins up a minimal Apache server on your local, serving the resulting build on port 8080. The project root provides a [docker-compose](https://docs.docker.com/compose/) file, which creates a clean build (with the same configuration as the production build) and spins up a minimal Apache server on your local, serving the resulting build on port 8080.