We'll be using Kotlin Multiplatform and Unity for our app, and Python and Javascript for our backend server code.
If you have used Java before, don't stress out - Kotlin is basically the same thing, just nicer looking. You can read some of the docs so you can make sure I am not lying.
Before you start any actual coding, you need to be familiar with a few concepts like CLI, Git, Server/Client Architecture and REST APIs. Luckily, you don't need to know them in depth, but just enough to be able to use them! Here's a few videos that'll help:
- Linux/Mac Terminal, Windows Powershell
- Git Crash Course
- Client Server Architecture
- REST API
- Using Postman - You don't need all of them, as long as you know how to make API Requests using Postman, you should be good.
Follow the steps below to get started with both codebases on your local machines:
Congratulations, you got the easiest onboarding experience.
- Install brew by copy-pasting this command in your terminal:
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" - Now you can install Android Studio, Postman, node, git and python using one magical command:
brew cask install android-studio postman adoptopenjdk14 && brew install node python git - Once Android Studio is installed, follow the Kotlin Setup to finish setting up your IDE.
- You can also install VSCode if you are coding Python or Javascript, but not much setup should be needed:
brew cask install visual-studio-code - Login to Git locally, and try to clone this repository. You should be able to clone it sucessfully.
The commands below are for Ubuntu. You should change the commands if you are using another package manager. You may need to add a sudo prefix to the commands if they throw a permissions error.
- You can install node, git and python using one magical command:
apt-get install adoptopenjdk14 nodejs python3 git - Install Android Studio, Postman and optionally VSCode by going to their website and following the installation instructions.
- Once Android Studio is installed, follow the Kotlin Setup to finish setting up your IDE.
Unfortunately, if you find yourself reading this you will be dealing with the most troublesome onboarding experiance.
- Go to the official Android Studio site and click "Download Android Studio". Make sure you are downloading the appropriate version (64 bit or 32 bit) and on your current version of Windows.
- You should have downloaded an .exe file. When the .exe file is finished downloading, click on it to start the download process.
- Accept all default settings, except if you see a setting for Kotlin. If you do, make sure to enable that setting.
- CAREFULLY, follow the instructions on the Kotlin Setup. Since Windows can be unpredictable, if you are having issues feel free to send me (Lucy) a message.
- Next, install VSCode here, making sure to download the appropriate version.
- Make sure you also have Python, Node.js, git and Postman installed. Follow the links and you should be good to go!
Go to either the backend repo or the frontend repo and click on issues to see the tasks that need to be completed. When you find something you want to do make sure to:
- Assign yourself to the issue.
- Comment on the issue what parts you want to do and if you need help @ the person you want to ask for help. Some issues are larger than others, so don't feel the need to tackle an issue entirely on your own!
- When you all your changes are approved and you have successfully merged to master, close the issue.