Skip to content

UNSW-iGEM/wiki-2020

Repository files navigation

UNSW_Australia 2020 Wiki

view the live version: https://2020.igem.org/Team:UNSW_Australia

Setup

Github and Git

If you have any issues with these setup steps send me a message on slack. I've tested them on windows.

Sign-up for a github account here.

Message @JackRobbers your github username so you can be added to the UNSW-iGEM organisation and make changes to the wiki code. You'll be able to view and edit the code locally before being added to the organisation, but not push any changes to the repo.

Download and install git from here. Set the default editor as either vscode or sublime. Leave every other option as the default.

Download and install github desktop from here. You'll use this tool to manage your changes and share them with the team.

Sign into your github account on github desktop.

Click "Clone a repository from the Internet..."

Type in "UNSW-iGEM/wiki-2020" and click clone. This downloads all of the wiki code onto your computer. It might ask you to "initilize git lfs", which you should do.

Node.js, NPM

Download and install node.js from here. Click the large green square under LTS that corresponds to your OS. WikiSync is built on node.js.

From Github Desktop, Select "Repository > Open in Command Prompt (Windows) / Open in Command Prompt (Mac)".

Type npm install and press enter. This will install all of the other software required to run the wiki code. If it doesn't work, reboot your computer to make sure node is installed correctly.

Usage

Running locally

npm start

Manual Push

Set your igem username and password as the environment variables IGEM_USERNAME and IGEM_PASSWORD respectively.

npm run build python3 wikisync.py

Git Usage

Command line

Git is a tool for managing and merging different versions of code.

git add filename git add -A git commit -m "a commit message" git push git pull git checkout -b branch_name git checkout

pull requests

Github Desktop

Wiki Team

  • Jack Robbers
  • Deborah Chandra
  • Cornelius Bong