{ "componentChunkName": "component---src-templates-page-js", "path": "/documentation/", "result": {"data":{"markdownRemark":{"html":"

This information is also publicly available on our GitHub repository.

\n

EUSO Website

\n

\"License:

\n

The official website of the Edinburgh University String Orchestra.

\n

Author

\n\n

License

\n

This project is open source and available under the MIT License.

\n
\n

This documentation is written for plain beginners.

\n

Development Setup

\n

Tools

\n

The project uses a few tools you need to have installed.

\n
    \n
  1. Follow along these instructions. Stop where it says 'Create a Gatsby Site'.
    2. \n
  2. You need to have a GitHub account.
    3. \n
  3. Download VS Code.
    4. \n
\n

Troubleshooting: Install nvm and node

\n

I had problems installing nvm and node on my mac, here is what I did to solve it:

\n

nvm is a Node Version Manager and let's you install and manage node versions.\nnode is a server environment.

\n
    \n
  1. Follow along this tutorial to install nvm.
    2. \n
  2. Run nvm --version in your terminal to ensure that it is installed.
    3. \n
  3. Run nvm install 14.4.0. This installs node v.14.4.0 on your machine.
    4. \n
  4. This shouldn't be necessary, but to be sure: Run nvm use 14 and node -v to check everything.
    5. \n
\n

Local Project Setup

\n

Clone Repository

\n
    \n
  1. Open VS Code.
    2. \n
  2. Click on the version control icon in the sidebar (the one below the search icon).
    3. \n
  3. Click on 'clone repository'.
    4. \n
  4. Go to the repository of this website on GitHub, click on 'clone' and copy the link.
    5. \n
  5. Go back to VS Code and paste the link, choose a folder where to save it on your machine and press enter.
    6. \n
\n

Link to GitHub

\n
    \n
  1. Open the Terminal in VS Code (type ctrl + shift + ` ).
    2. \n
  2. Run git init and git remote add clone-url (make sure to appropriately replace clone-url).
    3. \n
  3. Change this README.md file (add a space or whatever).
    4. \n
  4. Run git add . and git commit -m \"test commit\" and git push.
    5. \n
\n

Install Node Packages

\n
    \n
  1. Delete any package-lock.json or yarn.lock file you can find.
    2. \n
  2. Open Terminal within VS Code.
    3. \n
  3. Run yarn build.
    4. \n
\n

Test Run

\n

To check if everything worked:

\n
    \n
  1. Open Terminal within VS Code.
    2. \n
  2. Run gatsby develop.
    3. \n
  3. Click on the localhost link.
    4. \n
\n

You can type alt + c to terminate the process in your terminal.

\n

Project Structure (Content)

\n

Below are the files you need to edit if you want to change the content of our website.

\n

We distinguish between Markdown files and .js files.

\n

Good news: Markdowns files are very easy to edit. Markdown is a markup language which is easy to use. The file you're currently reading is made using Markdown. You can't really produce any errors which would stop this website from working (apart from providing the right fields at the beginning, but we'll come to that).

\n

Bad news: .js files are more ... delicate ... to edit. But also easy once you know what you're doing. You can produce errors which break the website so you have to be careful.

\n

You know if a page is not a markdown page if there is anything fancy on it which is not a normal text paragraph, picture or table.

\n

markdown pages: content/pages

\n

.js pages: src/pages

\n

If you look at these directories and the page names, you know which page relates to which page on the on-line website.

\n

Changing Content

\n

Run gatsby develop in your vs code terminal and go to the localhost page. You can see there the changes you make to your website.

\n

Main things you need to keep updated:

\n

Composer Typing Animation

\n\n
<Typewriter\n...\n  texts={['Shostakovich', 'Dvořák', 'Beethoven', 'Britten', 'Bridge']}\n...
\n\n

Add a News Article

\n\n
---\ndate: 2020-07-06\ntitle: 'A Positive Note'\ntemplate: post\nslug: 2020-07-06-positive-notes\ncategories:\n  - News\ntags:\n  - 'covid'\n  - 'positive notes'\n  - 'euso'\n  - 'edinburgh university string orchestra'\n  - 'edinburgh'\n  - 'university of edinburgh'\n---
\n\n

Update .js pages

\n\n

Update .md pages

\n\n

How do I know which page is a markdown page and which page is a .js page?

\n

If you don't have any idea, just search for the text you want to change with the search icon on the left sidebar. It'll get you to the file you want to change. Just make sure not to edit files within the public folder.

\n

Publishing the Changed Content

\n

Once you've updated the content you want to publish them under our https://string.eusa.ed.ac.uk/ domain.

\n\n

Congratulations, you're updates should now (or within a few seconds) be online!

","timeToRead":6,"excerpt":"This information is also publicly available on our GitHub repository. EUSO Website License: MIT The official website of the Edinburgh…","frontmatter":{"title":"Documentation","template":"page"},"fields":{"slug":"/documentation/","date":null}}},"pageContext":{"slug":"/documentation/"}}, "staticQueryHashes": []}