Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running.
Placeholder | Replace With | Example Value |
---|---|---|
com.wails.myfirstapp |
Your app’s module/package identifier | com.yulesxoxo.autoclicker |
com.mycompany.myproduct |
The unique product identifier | com.yulesxoxo.autoclicker |
myfirstapp.exe |
The name of the generated binary/executable | AutoClicker.exe |
myfirstapp |
Project name (no whitespace) | AutoClicker |
My Product Name |
Your application/product name | Auto Clicker |
My Product |
Your application/product name | Auto Clicker |
My Company |
Your company/organization name | yulesxoxo |
My Product Description |
A short description of your application | It's an Auto Clicker |
A program that does X |
The application description | It's an Auto Clicker |
Some Product Comments |
Comments | Lorem ipsum |
This is a comment |
Comments | Lorem ipsum |
changeme |
go module | autoclicker |
© now |
Current year | © 2025 |
(c) Now |
Current year | (c) 2025 |
Navigate to your project directory in the terminal.
To run your application in development mode, use the following command:
wails3 dev
This will start your application and enable hot-reloading for both frontend and backend changes.
To build your application for production, use:
wails3 build
This will create a production-ready executable in the build
directory.
Now that you have your project set up, it's time to explore the features that Wails3 offers:
Check out the examples: The best way to learn is by example. Visit the examples
directory in the v3/examples
directory to see various sample applications.
Run an example: To run any of the examples, navigate to the example's directory and use:
go run .
Note: Some examples may be under development during the alpha phase.
Explore the documentation: Visit the Wails3 documentation for in-depth guides and API references.
Join the community: Have questions or want to share your progress? Join the Wails Discord or visit the Wails discussions on GitHub.
Take a moment to familiarize yourself with your project structure:
frontend/
: Contains your frontend code (HTML, CSS, JavaScript/TypeScript)main.go
: The entry point of your Go backendapp.go
: Define your application structure and methods herewails.json
: Configuration file for your Wails projectfrontend/
directory to create your desired UI.main.go
.wails3 dev
to see your changes in real-time.wails3 build
.Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community.