# SOAR Websites
## General Software
### Visual Studio Code
Install from https://code.visualstudio.com/docs/setup/windows.
* Can use all default options
### git
Download and install from https://gitforwindows.org/
* At "Choosing the default editor used by Git", you can select "Use the Nano editor by default"
* Everything else can be left at the default option
### Node 10.14.1
Install from https://nodejs.org/dist/v10.14.1/node-v10.14.1-x64.msi
* Can use all default options
# robocla.sh
## Key Details
Domain bought on 29 Aug 2021 for **1 year**.
Domain Registrar: namecheap.com
```
sutdsoar
cA*jbuJ4Z6qfXv3xX%kA
```
DNS service: cloudflare.com
```
soar@club.sutd.edu.sg
oZ#bvo7cr2sWS2$BxT2m
```
Webpage hosting: GitHub Pages
Test link: http://ny6nspzfgn.robocla.sh/
Repository link (2022): https://github.com/sutd-robotics/roboclash2022
Repository link (2023): https://github.com/sutd-robotics/roboclash2023
Webpage link: https://robocla.sh
Testpage link: https://ny6nspzfgn.robocla.sh/
Gmail Account:
```
sutdroboclash@gmail.com
x@Fz!NX3WhSQUARBu4cF
```
## Software Required
Live Server extension for VS Code - https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer
* For local development
## Cloning the project
- Open file explorer and find the folder you would like to store the project.
- Right-click and select "Git Bash Here"
- Paste the following command
```
git clone https://github.com/sutd-robotics/roboclash2023
```
> When running for the first time, you'll be asked to login. Click login with browser.
> Keyboard shortcut to paste is `Shift + Ins`
## Local Testing
- Open `index.html` in VS Code
- Click on "Go Live" at the bottom right of VS Code. If you don't see the button means the Live Server extension is not installed
## Deploying using GitHub pages
- Go to the GitHub repo
- Click on `Settings`
- Click on `Pages`
- Specify the branch to deploy
- Specify custom domain (optional)
# soar.opensutd.org
## Key Details
Repository link: https://github.com/sutd-robotics/sutdsoar
Hosting: Heroku (owned by James)
- Will automatically build and serve when changes are pushed to the git repository
## Cloning the project
- Open file explorer and find the folder you would like to store the project.
- Right-click and select "Git Bash Here"
- Paste the following command
```
git clone https://github.com/sutd-robotics/sutdsoar
```
> When running for the first time, you'll be asked to login. Click login with browser.
> Keyboard shortcut to paste is `Shift + Ins`
## Installing Dependencies
- Open the project folder
- Hold down `Shift` while right-clicking and select `Open PowerShell window here`
- Run the following command
```
npm install
```
- Fix a cache issue by running the command
```
npm config set cache C:\tmp\nodejs\npm-cache --global
```
- Run the development server
```
npm run dev
```
> This might take a while, be patient
- Go to your browser and go to http://localhost:3000