dojoengine / dojo.js

Official JavaScript packages for Dojo.
https://dojoengine.github.io/dojo.js/
MIT License
28 stars 47 forks source link

feat: add kitchen sink example #281

Closed MartianGreed closed 1 month ago

MartianGreed commented 1 month ago

Closes #

Introduced changes

-

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces a new submodule for "onchain-dash" and a comprehensive set of files for a Vite-based React application. Key additions include configuration files, components, and a README, establishing a modern development environment with Tailwind CSS and the Dojo Engine. The existing submodule remains unchanged, while new files support the on-chain dashboard project. Additionally, the .gitignore file has been updated to exclude the local Netlify folder.

Changes

Files Change Summary
.gitmodules Added new submodule onchain-dash with path worlds/onchain-dash and URL https://github.com/MartianGreed/onchain-dash. Duplicate entry for the same submodule also added.
.gitignore Updated to include .netlify in the list of ignored files and added a newline for formatting.
examples/example-vite-kitchen-sink Introduced various files for a Vite-based React application, including configuration, components, and styles. New components and interfaces added, along with functions and constants for enhanced functionality.
examples/example-vite-kitchen-sink/.env.dist Added environment variables for the application, defining RPC URLs and API keys.
examples/example-vite-kitchen-sink/.eslintrc.json Introduced ESLint configuration extending Next.js rules for TypeScript.
examples/example-vite-kitchen-sink/.gitignore Specified files and directories to be ignored by Git.
examples/example-vite-kitchen-sink/README.md Provided instructions for getting started with the project and running the development server.
examples/example-vite-kitchen-sink/components.json Configured settings for the Shadcn UI framework.
examples/example-vite-kitchen-sink/index.html Main HTML entry point for the Vite application.
examples/example-vite-kitchen-sink/package.json Defined project dependencies, scripts, and metadata.
examples/example-vite-kitchen-sink/postcss.config.mjs Configured PostCSS to use the Tailwind CSS plugin.
examples/example-vite-kitchen-sink/src/app/globals.css Established base styles and utilities using Tailwind CSS.
examples/example-vite-kitchen-sink/src/app/layout.tsx Defined the RootLayout component to integrate providers and UI elements.
examples/example-vite-kitchen-sink/src/app/page.tsx Implemented the Home component for the dashboard interface.
examples/example-vite-kitchen-sink/src/components/ Introduced various UI components for the application, including counters, chat, headers, and sidebars.
examples/example-vite-kitchen-sink/src/dojo/ Defined Dojo Engine configuration and schema for the on-chain dashboard.
examples/example-vite-kitchen-sink/src/env.ts Set up environment variables and exported a function for constructing RPC URLs.
examples/example-vite-kitchen-sink/src/lib/utils.ts Added utility functions for class name management and value handling.
examples/example-vite-kitchen-sink/src/main.tsx Initialized the React application using the React 18 API.
examples/example-vite-kitchen-sink/tailwind.config.ts Configured Tailwind CSS settings, including dark mode and theme extensions.
examples/example-vite-kitchen-sink/tsconfig.json Specified TypeScript compiler options for the project.
examples/example-vite-kitchen-sink/vite.config.ts Set up Vite project configuration with necessary plugins.

Possibly related PRs

Poem

In a garden of code, where the bunnies play,
New modules sprout, brightening the day.
With Vite and React, we hop and we cheer,
Tailwind and Dojo, our vision is clear!
So let’s build our dreams, with joy and delight,
In this wondrous code world, everything feels right! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.