Windsurf Demo Starter Kit

Welcome to the Windsurf Demo Starter Kit! This repository is designed to help you explore and demonstrate the capabilities of Windsurf, an agentic IDE that can help you build complete applications with minimal effort.

What is Windsurf?

Windsurf is a revolutionary agentic IDE that helps you write code, build APIs, create frontends, dockerize applications, and implement test automation. It operates on the AI Flow paradigm, enabling it to work both independently and collaboratively with you.

Getting Started

Prerequisites

1. Download and install Windsurf from windsurf.ai (placeholder URL)
2. Ensure you have Git installed

Setup Instructions

1. Clone this repository:

   git clone git@github.com:Hainguyen1210/windsurf-demo.git
   cd windsurf-demo

2. Run the initialization script:

   ./init.sh my-project-name my-branch-name

   This will create a new directory with the specified name, copy the templates, and initialize a Git repository.

3. Open the new project in Windsurf and start building!

Repository Contents

• Windsurf Prompt Guide: A comprehensive guide with example prompts for building a complete application
• Demo Script: A sample demo script to showcase Windsurf's capabilities
• Templates: Starter templates for backend and frontend components
  • Backend: Go/Gin API template
  • Frontend: React application template
  • Testing: Selenium test automation template
• Initialization Script: Script to quickly set up a new project

Demo Ideas

Here are some project ideas you can build with Windsurf:

1. Task Manager: A simple task management application with CRUD operations
2. Weather App: An application that fetches and displays weather data
3. Blog Platform: A blog with posts, comments, and user authentication
4. E-commerce Store: A simple online store with products and a shopping cart
5. Chat Application: A real-time chat application

How to Use This Repository

This repository is designed to be a starting point for your Windsurf demos. Here's how to use it effectively:

1. Read the Prompt Guide: The Windsurf Prompt Guide contains example prompts for building a complete application.

2. Choose a Project: Select one of the demo ideas or create your own.

3. Start Prompting: Use the example prompts as a starting point, modifying them to fit your specific project.

4. Iterate and Refine: Start with basic functionality and gradually add more features.

5. Share Your Results: Consider contributing your successful prompts back to this repository!

Tips for Successful Demos

1. Start Simple: Begin with a clear, focused objective
2. Be Specific: Provide detailed instructions in your prompts
3. Show Incremental Progress: Demonstrate how Windsurf helps at each stage of development
4. Highlight Time Savings: Emphasize how Windsurf accelerates development
5. Be Prepared for Questions: Understand how the generated code works

Contribution

Feel free to contribute to this starter kit by submitting pull requests or opening issues!

License

This project is licensed under the MIT License - see the LICENSE file for details.