Development Environment Setup (Step-by-Step Guide)
This guide will help you set up your local development environment to complete coding assignments successfully.
Please follow each step carefully.
1. Create a GitHub Account
Steps:
- Open your web browser and go to https://github.com/.
- Click Sign Up.
- Enter your:
- Email address
- Create a username
- Create a password
- Verify your email address.
- Your GitHub account is ready.
Tip: Use your Northeastern University email for easier access to student benefits.
2. Apply for GitHub ๐ Student Developer Pack
The GitHub Student Developer Pack gives you free access to many developer tools, including GitHub Copilot.
Steps:
- Open https://education.github.com/pack.
- Click Get Student Benefits.
- Log into GitHub if needed.
- Choose Student as your role.
- Submit proof of student status:
- Use your @northeastern.edu email address when possible.
- Important: If documentation is requested, upload a current transcript showing:
- Your full name
- The current semester
- Note: Student ID cards alone may not work โ they often do not show proof of current enrollment.
- Wait for approval (usually within a day or two).
Tip: You can continue setting up your environment while waiting for approval.
3. Install Visual Studio Code (VS Code)
Steps:
- Visit https://code.visualstudio.com/.
- Download and install the version for your operating system.
- Accept default installation options.
- Open VS Code to confirm it installed correctly.
4. Install Java (Amazon Corretto) โ
We will use Amazon Corretto 17 โ a free, reliable distribution of Java.
Steps:
- Visit https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html.
- Download and install the version for your operating system.
- Accept the license agreement.
-
Verify the installation by opening Terminal (Mac/Linux) or Command Prompt (Windows) and typing:
You should see output similar to:
openjdk version "17.0.9" 2023-10-17
OpenJDK Runtime Environment Corretto-17.0.9.8.1 (build 17.0.9+8-LTS)
OpenJDK 64-Bit Server VM Corretto-17.0.9.8.1 (build 17.0.9+8-LTS, mixed mode, sharing)
5. Install Git ๐
Git is essential for version control and submitting your assignments.
Steps:
- Windows:
-
macOS:
-
Verify installation by opening Terminal/Command Prompt and typing:
- Configure your Git identity:
git config --global user.name "Your Name"
git config --global user.email "your.email@northeastern.edu"
Required Extensions:
- Open VS Code
- Click on the Extensions icon in the sidebar (or press
Ctrl+Shift+X
)
- Install these essential extensions:
- Extension Pack for Java by Microsoft
- GitHub Classroom by GitHub
- Project Manager for Java by Microsoft
- Maven for Java by Microsoft
- Test Runner for Java by Microsoft
- Open VS Code Settings (
Ctrl+,
or Cmd+,
on Mac)
- Search for โjava homeโ
- Set the path to your Amazon Corretto JDK installation:
- Windows:
C:\Program Files\Amazon Corretto\jdk17.x.x_x
(adjust version as needed)
- Mac:
/Library/Java/JavaVirtualMachines/amazon-corretto-17.jdk/Contents/Home
- Linux:
/usr/lib/jvm/amazon-corretto-17
(may vary)
7. Set Up GitHub Copilot and GitHub Classroom ๐ค๐ซ
For detailed instructions on setting up and using these tools:
- See ๐ github-copilot-guide.md - Complete setup and usage guide for GitHub Copilot
- See ๐ github-classroom-guide.md - Instructions for joining and submitting assignments
8. Basic Git Workflow for Assignments ๐
Submit Your Work:
- Make changes to your code โ๏ธ
- Stage your changes:
- Commit your changes:
git commit -m "Meaningful description of your changes"
- Push your changes to GitHub:
Note: Always push your work before the โฐ deadline!
9. Troubleshooting
Java Not Found:
- Ensure Java is installed correctly
- Add Java to your PATH environment variable:
- Windows: Search for โEnvironment Variablesโ > Edit System Variables > Add to PATH
- Mac/Linux: Add
export PATH=$PATH:/path/to/java/bin
to your .bash_profile
or .zshrc
GitHub Authentication Issues:
- Try authenticating with a Personal Access Token (PAT)
- In GitHub: Settings > Developer Settings > Personal Access Tokens > Generate New Token
- Use this token when prompted for a password
VS Code Extensions Not Working:
- Check that you have the correct version of Java installed
- Restart VS Code after installing extensions
- Try reinstalling the problematic extension
Need Help?
If you encounter any issues not covered here, please:
- Post in the course Teams channel
- Check with classmates who may have solved the same issue
- Attend office hours for personalized assistance
10. Additional Resources ๐