- VS Code
- git
- For the Windows git installer, the default options are fine.
- Python 3
- For now, you don't need to install any virtual environment tools
- Using Terminal/Command Prompt, configure your identity for git commits:
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
- If on Linux, set up credential/password caching for git:
git config --global credential.helper 'cache --timeout=10000000'
# Set the cache to timeout after 10 million seconds = 16 weeks
Newer installations of git for Windows and Mac enable this automatically, but here are directions if you need to set it up.
- Node.js & npm ("Current" version)
- on Linux:
curl -sL https://deb.nodesource.com/setup_12.x -o nodesource_setup.sh sudo bash nodesource_setup.sh sudo apt-get install -y nodejs rm nodesource_setup.sh sudo chown -R $(whoami) ~/.npm
- IMPORTANT: On Windows, Node installation might break your Python launcher file association, causing all your scripts to run with Python 2 (yuck). Fix it by running this in Command Prompt:
ftype Python.File="py.exe" "%1" %*
- on Linux:
- Open VS Code
- Type
Cmd/Ctrl+Shift+P
to open the Command Pallette. - Type "clone" and hit enter to select "Git: Clone"
- Paste https://github.com/uas-at-ucla/ground-station.git for the repository URL.
- Enter your GitHub username and password if prompted.
- Click "Open" in the bottom right to open the cloned folder.
- Click "Open Workspace" to load the workspace settings.
- Click "Install All" to install the recommended extensions for the ground-station project.
- Open a terminal to the ground-station folder. The easiest way to do this is by typing
Ctrl+`(backtick)
or selectingView -> Terminal
from VS Code. - To install dependencies for the ground station projects, run:
./ground.py build
This will take a while.
The ground.py
script has various options to build/run different ground station projects. Try ./ground.py --help
and ./ground.py run --help
.
./ground.py run ui
If you open a '.ts' (TypeScript) file in the ui project, you should notice some handy features made possible by the eslint VS Code extension as well as the .eslintrc.json config file:
- Various warnings/errors are shown that catch potential problems and enforce best practices. It's ok to have some warnings, but they should often be addressed.
- Whenever you save a file, it is auto-formatted.