https://github.com/coderoad/coderoad-vscode

👩‍💻 Create or play Interactive coding tutorials in VSCode
https://github.com/coderoad/coderoad-vscode

tutorial tutorial-code tutorial-exercises vscode vscode-extension

Last synced: about 1 month ago
JSON representation

👩‍💻 Create or play Interactive coding tutorials in VSCode

• Host: GitHub
• URL: https://github.com/coderoad/coderoad-vscode
• Owner: coderoad
• License: agpl-3.0
• Created: 2019-05-26T05:39:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T02:36:58.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T08:03:10.275Z (about 2 months ago)
• Topics: tutorial, tutorial-code, tutorial-exercises, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://coderoad.github.io
• Size: 12.5 MB
• Stars: 948
• Watchers: 12
• Forks: 38
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  





CodeRoad





  

  

   



CodeRoad is a VSCode extension that allows you to create and play interactive coding tutorials in your editor.

Works with a variety of languages: JavaScript, Python, Bash, SQL, with more to come.

![CodeRoad Example](./docs/static/gif/coderoad-example.gif)

---

## [📖 Documentation](https://coderoad.github.io/docs/overview)

- [Create a Tutorial](https://coderoad.github.io/docs/build-tutorial)

- [Develop the Extension](https://coderoad.github.io/docs/development)

## How CodeRoad Works

1. Text is written in Markdown. [🔗](https://github.com/coderoad/fcc-learn-npm/blob/master/TUTORIAL.md)

2. Tutorials are built on Git using a TDD pattern. [🔗](https://github.com/coderoad/fcc-learn-npm/commits/v0.4.2)

3. Hooks & actions give flexible access to the command line & VSCode API. [📖](https://coderoad.github.io/docs/hooks-actions/)

▶️  [See a video explaining how CodeRoad works](http://www.youtube.com/watch?v=htrbKlgAvuE 'How CodeRoad Works')

📖  [Learn more](https://coderoad.github.io/docs/how-coderoad-works)

---

## Getting Started

### Requirements

- OS: MacOS, Linux, Windows

- VSCode 1.39.2+

- Git

### Install

1. install CodeRoad from [the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).

2. reload the window (`ctrl/cmd + R`) to get started.

### Start

![CodeRoad Example](./docs/static/gif/launch-coderoad.gif)

To start the extension, inside VSCode:

- Open an **empty** VSCode workspace (a project folder)

- Launch the app from the VSCode command palette. How?

  - select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`

  - in the command palette popup, search for and run `CodeRoad:Start`

---

## Contributing

CodeRoad is an ambitious project, we're always looking for contributors :)

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

[AGPL v3](./LICENSE.md)

## Contact & Support

- Create a [GitHub issue](https://github.com/coderoad/coderoad-vscode/issues/new/choose) for bug reports, feature requests, or questions

- Reach out at `[email protected]`

- Leave [a review](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad&ssr=false#review-details) in the VSCode Marketplace

- Add a ⭐️ star on GitHub to support the project!