Skip to content

A sample code base with walkthrough instructions for users to explore Windsurf

License

Notifications You must be signed in to change notification settings

mbatchelor81/windsurf-walkthrough

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Windsurf Walkthrough

Welcome to the Windsurf Walkthrough! This project includes a sample code base and suggested flows (prompts + user actions) as you get hands-on with the Windsurf Editor.

Instead of providing an exhaustive demonstration of all Windsurf's capabilities as your AI coding assistant, this project focuses on a few representative user flows and key takeaways for working with Windsurf.

For the latest information on Windsurf, check out Windsurf University and the Windsurf Documentation

Repository Structure

./
├── contact-form-app/        # Example codebase (React + Python)
└── walkthrough/             # Introductory step-by-step walkthroughs
    └── for-administrators/  # Reference material for Windsurf Administrators
    └── challenges/          # Open-ended tasks for Windsurf users to continue exploring

Getting Started

Prerequisites

You will need to:

  • Install the Windsurf Editor
  • Clone this repository Clone Repository
  • Run the /initialize-dev-environment workflow in Cascade to setup your local development environment Initialize Dev Environment

Introductory Tutorials

Begin by working through the walkthrough to explore sample flows that demonstrate how to effectively collaborate with your AI coding assistant.

While these files are available on your local machine, it is recommended you open them in Github for better readability.

Contributing

If you'd like to contribute to this project, please review the CONTRIBUTING.md file for guidelines on how to submit changes and improvements.

Disclaimer on Non-deterministic Behavior

While your specific interactions with Windsurf may vary, the goal is to demonstrate how Windsurf helps you stay in the flow so you can dream bigger.

About

A sample code base with walkthrough instructions for users to explore Windsurf

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •