Developing with Frontend & Backend
To get started with development, you need tools. You'll learn how to get the necessary tools here using Conda scripts.
GitHub
- What is GitHub?
- GitHub is a web-based platform that uses the Git version control system to manage and store code repositories.
- Why do we use GitHub? Why not Google Drive or messages?
- GitHub is specifically designed for version control of code and offers a range of collaborative tools that enable developers to work together on software projects more efficiently.
- What's the difference between Git and GitHub?
- Git is a distributed version control system used for tracking changes in source code files during software development, while GitHub is a web-based platform that uses Git as its underlying version control system.
- Name as many Git commands as you can:
- git pull
- git push
- git merge
- git clone
- git add
- git init
- git log
Two Main Machines
- Which is better, MacOS or Windows?
- In, my opinion, Windows is better out of the two options given. However, Linux is better than both.
- Give some differences between MacOS and Windows in terms of the development we use in APCSP:
- For MacOS, you have an ubuntu/Linux terminal preinstalled while for Windows, you have to install WSL.
- If you are on Windows, you want to skip the MacOS Setup instructions.
Our Tools:
- What is the first tool you remember installing?
- The first tool I remember installing was WSL in Windows Powershell.
- Why was installations so hard the first time?
- I've never worked with Ubuntu/Linux before so it was very difficult for me to figure out what to do.
- Without looking back at previous notes, name three tools you remember installing. This can be kernels, extensions, any installation for APCSP, and also write why it is needed.
- I remember installing, Bash, Anaconda, and VSCode. Bash was needed because it allowed me to run commands and scripts on my computer by typing them in the terminal. Anaconda was needed to easily install, update, and manage packages and dependencies for Python. VSCode is the most used out of the 3 and we use it everyday for working on code or just taking notes.
Actual Installations:
Tool setup is a week 0 thing. You should already have the knowledge to set up your machine. There is also a high chance you had to remove your environments and set up your machine again due to errors. If, for some reason, these don't apply to you, go here to set up your machine, here to check everything working with Bash, and here for Docker setup, which are the main tools on our machine needed to develop in APCSP.
brew list # list packages
brew update # update package list
brew upgrade # upgrade packages
brew install git # install latest git
brew install python # install python3 for development
python --version # version of python3 installed
brew install java # openjdk install
wsl --install
wsl --list
wsl --install -d Ubuntu-20.04
# restart machine
wsl
cd ~
mkdir vscode
ls
cd ~/vscode # changes the directory to path for vscode files
git clone https://github.com/nighthawkcoders/APCSP.git # clone repo
cd APCSP # changes the directory to path for APCSP repos assets
code . # opens APCSP in VSCode
cd .. # changes the directory to the previous/parent directory
git config --global user.email mygmail@gmail.com # tell git your email
git config --global user.name mygithub # tell git your github id
shay@MSI:/mnt/c/Users/ShayM$ git config --global user.email your@email.here
shay@MSI:/mnt/c/Users/ShayM$ git config --global user.name yourusernamehere
# restart machine
PS C:\Users\UserName> wsl # Windows prompt to WSL command
cd /tmp
wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
chmod +x Anaconda3-2022.05-Linux-x86_64.sh
# Answer yes to all the prompts
./Anaconda3-2022.05-Linux-x86_64.sh
# run apt package commands now
sudo apt list # list packages
sudo apt update # update package list
sudo apt upgrade # upgrade packages
sudo apt install python2 # install python2 for package dependencies
sudo apt install python3 python3-pip # install python3 and pip3 for development
python --version # version of python3 should be shown
sudo apt install default-jdk default-jre # java install
java --version # java runtime version
javac --version # java compiler version
sudo apt install unzip # unzip utility
(base) id:~$ conda --version
(base) id:~$ conda install jupyter # install jupyter
(base) id:~$ jupyter kernelspec list # list installed kernels
Available kernels:
python3 /home/shay/.local/share/jupyter/kernels/python3
(base) id:~$ # start in home directory
(base) id:~$ pip install bash_kernel # download bash kernel
Collecting bash_kernel
Downloading bash_kernel-0.7.2-py2.py3-none-any.whl (15 kB)
Requirement already satisfied: pexpect>=4.0 in ./anaconda3/lib/python3.9/site-packages (from bash_kernel) (4.8.0)
Requirement already satisfied: ptyprocess>=0.5 in ./anaconda3/lib/python3.9/site-packages (from pexpect>=4.0->bash_kernel) (0.7.0)
Installing collected packages: bash-kernel
Successfully installed bash-kernel-0.7.2
(base) id:~$ python -m bash_kernel.install # install kernel
Installing IPython kernel spec
(base) id:~$ jupyter kernelspec list # list kernels
Available kernels:
bash /home/shay/.local/share/jupyter/kernels/bash
python3 /home/shay/.local/share/jupyter/kernels/python3
(base) id:~$ conda install nodejs # node is framework for JavaScript kernel
(base) id:~$ npm -version # node package manager comes with nodejs
(base) id:~$ npm install -g ijavascript # get the kernel
(base) id:~$ ijsinstall # install javascript kernel
(base) id:~$ jupyter kernelspec list # list kernels
Available kernels:
bash /home/shay/.local/share/jupyter/kernels/bash
javascript /home/shay/.local/share/jupyter/kernels/javascript
python3 /home/shay/.local/share/jupyter/kernels/python3
By now, you should already know how to clone Git repositories into your VSCode directory. Once you do that, you're all set for developing with GitHub Pages and Fastpages!
Before We Set Up Pages, A Guide to Git
As we've discussed, Git is different from GitHub. Because GitHub is merely the place where we store Git repos, we use Git's commands to help us get, open, and configure these repositories. Here are some of the Git commands you should be using a lot (In the comments, tell what each Git command does):
git clone {repos-name-here.git} # what does it do? This command clones the repo and copies the github repository into your VSCode editor.
git checkout [branch] # what does it do? This command switches your current working branch to the specified branch in your local repository.
git fork {repos-name-here.git} # what does it do? This command creates a copy of a repository on your GitHub account, which allows you to make changes without affecting the original repository.
git commit -m {"commit-msg"} # what does it do? This command saves changes to your local repository and creates a new commit with a message describing the changes made.
git pull # what does it do? This command fetches changes from the remote repository and merges them with your local repository.
git push # what does it do? This command sends committed changes from your local repository to the remote repository.
# After this line, name other commands that you can use and what they do. This should be easy, as you've already answered the question
git init # This command displays the commit history of a Git repository, showing all the commits made, their metadata (author, date, commit message), and a unique identifier for each commit.
Setting Up GitHub Pages
Some of you may have come to know that GitHub Pages is starting to become outdated. So why do we still use it? The answer is that we are in a class, and following a curriculum with something like GitHub Pages is much easier than creating portfolio content from scratch, which becomes quite unecessary. Therefore, we can use GitHub Pages to create this content instead. On the topic of unecessary vs necessary coding, we don't need to make GitHub Pages from scratch as opposed to using a template that our very own Mr. Mortensen created for us. To do that, we can go to the Leuck Reunion repository and use the template to make our own GitHub Pages. Then, in Ubuntu, we can git clone
our repository and open it in VSCode. After we have it open, the last thing we want to do is set up local hosting for this website, so that we can preview it and make changes in real time. To do that, head here to install Jekyll for Ubuntu, here to install Ruby next, and here to finalize the process by installing Bundler.
Setting Up FastPages
In Setting Up Github Pages, we talked about how it is easier to use a template to create portfolio content. It is also easier to use a template when creating the portfolio itself. To do that, we can use Fastpages, which is what we have been using to show our blogs, code, and projects. However, Fastpages has been deprecated for some time now, so the instructions in Week 0 won't be effective. So, we need to fork the APCSP Fastpages. To do that, follow this video to get started developing with Fastpages.
Hacks
- Show how you incorporate three tools that we have installed into your project. 0.1 points for each feature. (0.3). This can include code, but definitely blog about it.
- Fastpages:
- This is a frontend for one of our GitHub repositories that displays all the programs
- WSL:
- This is a directory where repositories can be cloned, and various Git commands can be executed to manage repositories, such as adding, deleting, or cloning them. Additionally, WSL can be used to run Linux commands and servers.
- VSCode:
- Git is used for coding and pushing to GitHub, and VSCode makes it easier to code and use programs by cloning Git repositories.
- Fastpages:
- frontend hack goes here
- backend hack goes here