/
Onboarding Checklist

Onboarding Checklist

Owned by Jacky Xie
Last updated: Feb 20, 2023 by Brian Wang
2 min read

Checklist

Prerequisites

Setup homebrew/WSL2
Setup VScode/ preferred IDE
Install Git Git - Downloads
Install node.js and npm through nvm (look below!)
Have a lot of ram (Docker is consumes a lot of memory)

Checklist

Activate your CSESoc account
Accept invite to CSESoc github organisation
Set up ssh key for github (look below!)
Install Docker desktop (look below!)
Set up a Figma account (mainly for FE team) (look below!)
Get .env files from your team lead
Clone the repo, run the application and explore! https://github.com/csesoc/website
Read the git standards/PR guide Git Standards
Read through the following documentation
Frontend concepts (FE)
Code style and standards (FE)

Node.js, nvm, npm

Explanation of node.js

“Node.js is an open-source, cross-platform, JavaScript runtime environment that executes JavaScript code outside of a browser” (Node.js org, 2020)

Explanation of nvm and npm

“NVM is a node.js version manager. It provides easy installation, switching between versions and retains globally installed packages for each version. NPM is a package manager, which help you install libraries, plugins, frameworks and applications.”https://medium.com/@hanke.liu/understand-node-js-npm-and-nvm-efc61dfd7ff8#:~:text=NVM%20is%20a%20node.,%2C%20plugins%2C%20frameworks%20and%20applications.

Installation

https://medium.com/@iam_vinojan/how-to-install-node-js-and-npm-using-node-version-manager-nvm-143165b16ce1

Setting up ssh key

# Run this command for a projects specific SSH Key ssh-keygen

It will prompt you to enter the file where you want to save the key (this is equivalent to naming your ssh key), I personally prefer to use something like id_rsa_CSE. If you have multiple ssh keys, which most people would have i.e. one for gitlab (1531), you can create a SSH Config file

# Example SSH Config saved in ~/. ssh/config Host github.com Hostname github.com PreferredAuthentications publickey IdentitiesOnly yes IdentityFile ~/.ssh/id_rsa_CSE

Now navigate to the Settings tab inside github, and go to the SSH and GPG keys tab, and add a new SSH Key. To get the ssh key there are a couple of commands you can run:

  • cat ~/.ssh/id_rsa_CSE.pub | pbcopy (OSX)

  • cat ~/.ssh/id_rsa_CSE.pub | clip.exe (WSL2)

  • or you can just run cat ~/.ssh/id_rsa_CSE.pub and copy the contents manually, However, it is very easy to mess up the copy with missing characters/extra spaces so beware!

Docker desktop

What is Docker?

https://www.youtube.com/watch?v=rOTqprHv1YE

Installation

Follow the installation guide to install docker desktop Get Docker

Disclaimer: You can only run your docker application in the CLI when the docker desktop is open, and are signed in. Please refer the instructions in the repo https://github.com/csesoc/cms.csesoc.unsw.edu.au/blob/main/README.md to run the docker application.

Figma (mainly for FE team)

What is Figma?

Figma is a collaboration tool for interface design that offers a variety of prototyping features.

Installation

Related content

UNSW CSESoc