To build the site for the first time on your computer:
- Install juliaup (run
curl -fsSL https://install.julialang.org | shorbrew install juliaupin a terminal on macOS or Linux, orwinget install julia -s msstoreon Windows) - Use juliaup to install julia (in a terminal, type
juliaup add release). - Clone this repository
- Navigate to the repository directory in a terminal
- Start julia and activate this environment with
] activate ., where]is the command to enter the julia REPL Package mode. The prompt should say "presagegroup-com" if this worked correctly. - Instantiate this environment with
instantiatewhile still in package mode. - At the normal julia prompt (use backspace to exit package mode, your prompt should now say "julia>"), type
using Xranklin, Reviseto loadXranklin.jl. serve(clear = true)will start a local server at http://localhost:8000 and open a preview of the site in your browser. The site will update live when you make changes.
To make a change to the website:
- Fetch the current state of the repo from github. In github desktop, this is done by clicking the "Fetch origin" button at the top.
- Make a local branch with a name that describes your intended change ("september-blog-post", "new-fitforflight-page", "fix-darkmode", etc.). In github desktop, click on the down arrow beside "Current branch" and type your name into the box, then click the "New branch" button.
- Make changes locally and commit them. Commits can either be based on completing pieces of the work (e.g. "first paragraph added") or just over time (e.g. "end of day may 12"). Aim to not make too many changes between commits.
- Build the site locally to preview your change. See instructions above (you can start from step 4). Make changes if required and the changes should update the preview.
- Push your branch to github (button in the top bar of github desktop). This should be done at minimum once per day so your work is backed up.
- Repeat steps 3-5 until you are happy with your changes
- Make a pull request from your branch to main. This can be done on the github website under "Pull Requests". Click the green button and ask for a review from someone else in analytics just to make sure nothing has broken.
- They merge the changes to main and they will be live in a couple minutes.
- Once a pull request has been safely merged and closed, delete your created branch.