📌Introduction

The Splunk UI Toolkit is a comprehensive set of React components and development tools that allows developers to create modern, responsive Splunk applications. This toolkit provides pre-built components that follow Splunk’s design system, making it easier to build consistent and professional-looking apps.

In this tutorial, you’ll learn how to create your first Splunk React application from scratch using the official Splunk UI Toolkit.

⚡Prerequisites

Before starting, ensure you have the following installed and configured:

  • Node.js (version 14.x or higher)
  • npm or yarn package manager
  • Splunk Enterprise (version 8.0 or higher) running locally
  • Administrator access to your Splunk instance
📁 1. Go ahead and create a directory or a folder outside your splunk directory.
💻 2. Open a terminal on your directory.
⚙️ 3. Run npx @splunk/create command in your terminal.
❓ 4. The above command will ask you “What would you like to create?” 
✅ 5. Select A monorepo with a React Splunk app and a React component option.
📝 6. Then it will ask Component Name, Repository Name and App Name                                                                                                Note: Please use CamelCase and avoid any special characters or spaces in your names.
📂 7. It will create a directory structure will look something like below 
– App directory
– Component directory
🔧 8. Run yarn run setup command in your terminal
🏗️ 9. This Command will resolve all the dependencies and build your application.
📂 10. Then go to your app directory.
🔗 11. Run yarn run link:app command.
🔗 12. This will create a shortcut in your $Splunk_Home/etc/apps directory.
▶️ 13. Run yarn run start command
🔄 14. Then go ahead and Restart your Splunk.
🎉 15. You will see your app in your splunk.

🚀 What’s Next?

After successfully setting up your app, you can:

✨ Customize Components – Modify your React components
🎨 Style Your App – Add custom CSS and themes
📊 Integrate Data – Connect with Splunk’s REST API
🔍 Add Search Features – Implement Splunk search functionality

If you are still facing an issue, feel free to Ask Doubts in the Comment Section Below and Don’t Forget to Follow us on 👍 Social Networks.

| Happy Splunking 😉