Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated docs on deployment of the site #26

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,21 @@ The google sheet controlling the information can be found
- Talk Slides
- Displaying general information about the society
- Mobile friendlyish
- Automatic build daily on github

## Deployment

1. git clone the repo.
2. run `yarn`.
3. ensure the `homepage` in `package.json` is set correctly.
4. ensure `siteMetadata.dataURL` in `gatsby-config.js` is set to pull
information from the correct JSON file.
5. run `yarn build`.
6. ensure there are no errors in the output.
7. copy & paste the static files in the build folder that has been created.
This is your site now :)

- Ensure the JSON file `siteMetadata.dataURL` is set to pull from is being
regularly updated (~ once day)

- As of 19/11/2019, the release of this site, the `data.json` file can be pulled
from `fraz.redbrick.dcu.ie/data.json`
- This file is updated by a cron job running at 00:00 everyday. :)

Deployment has been made simple!
Github now builds the site daily. All you have to do is simply:
1. click on the latest build.
2. scroll down to artifacts.
3. download the tar, extract it.
4. deploy its content to redbrick using:
```
rsync -avh --chown=1001:1022 ./public/* hardcase:/storage/webtree/redbrick/htdocs
```
5. congrats, you're done!

## I want to make changes

Expand Down