Integrate GitHub Classroom with an IDE

You can preconfigure a supported integrated development environment (IDE) for assignments you create in GitHub Classroom.

About integration with an IDE

You can optionally configure an assignment to use an integrated development environment (IDE). IDEs allow your students to write code, run programs, and collaborate without installing Git and a full development toolchain on the student's computer. If you choose an IDE for an assignment, students can still check out and run code locally on a computer with the necessary software.

After a student accepts an assignment with an IDE, the README file in the student's assignment repository will contain a button to open the assignment in the IDE. The student can begin working immediately, and no additional configuration is necessary.

Supported IDEs

GitHub Classroom supports the following IDEs. You can learn more about the student experience for each IDE.

IDEMore information
Microsoft MakeCode Arcade"About using MakeCode Arcade with GitHub Classroom"
Visual Studio CodeGitHub Classroom extension in the Visual Studio Marketplace

We know cloud IDE integrations are important to your classroom and are working to bring more options.

Configuring an IDE for an assignment

You can choose the IDE you'd like to use for an assignment when you create an assignment. To learn how to create a new assignment that uses an IDE, see "Create an individual assignment" or "Create a group assignment."

Authorizing the OAuth app for an IDE

The first time you configure an assignment with an IDE, you must authorize the OAuth app for the IDE for your organization.

For all repositories, grant the app read access to metadata, administration, and code, and write access to administration and code. For more information, see "Authorizing OAuth Apps."

Further reading

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.