Table of Contents

Loading Your Repository

Note: Skip to Basic Model if using the Demo Diagram

Loading Repository From Local File System

Perfect for testing on private codebases

In local mode:

• Your source code and diagram data do not leave your device
• CodeCanvas server does not have access to your data
• No calls are made to CodeCanvas server

1. Go to code-canvas.com

2. Click Open Project From Local Device

3. Select the root level folder of your project

   Note: If loading existing file, you must select the parent folder of the .codecanvas file!

4. CodeCanvas will either load from existing .codecanvas file or will create the file at save

• Select the repo branch of interest from the drop down list

Loading Repository From Github

Perfect for when you don’t have the code repository cloned locally. Note: After Pushing to Github, Github API takes around 1 minute for the newly saved diagram to be refreshed in the Github API database.

In this mode:

• you can load from, and save to Github directly and collaboration across team members.
• you can work on code-canvas from a chrome browser on any device
• your diagram data and source code are only stored on Github and local browser storage (CodeCanvas does not have a database and so, it does not store any user information including diagram and source code)

1. Go to code-canvas.com
2. Click Login with GitHub
3. Authenticate CodeCanvas GitHub Bot to make calls to pull data from your account.