-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6a41297
commit b2ba68a
Showing
1 changed file
with
77 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,115 @@ | ||
| [](https://github.com/knocks-public/2024-frameworks/actions/workflows/ci.yml) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| # StampCraft | ||
|
|
||
| ## Introduction | ||
| ETH Global Link: https://ethglobal.com/showcase/stampcraft-izphw | ||
|
|
||
| Welcome to **StampCraft**, the future of digital communication! StampCraft revolutionizes the way we think about online expression by allowing users to create and share LINE-style digital stamps. Built on the cutting-edge Forcaster protocol and integrated into the Warpcast platform, StampCraft is not just a tool but a gateway to a more engaging and expressive digital world. | ||
| ## Introduction | ||
|
|
||
| StampCraft is dedicated to bringing the charm and fun of customizable stamps to the Web3 space, allowing users to personalize their digital interactions with ease and creativity. Whether you're looking to convey emotions, reactions, or unique messages, StampCraft's adorable stamps are here to enrich your online communication. | ||
| Welcome to **StampCraft**, the groundbreaking application transforming online communication. By leveraging the innovative Forcaster protocol and integrating into the Warpcast platform, StampCraft was created during the 2024-Frameworks hackathon to introduce a novel way to create and share LINE-style digital stamps. Dive into a world where expressing emotions, reactions, or conveying unique messages is not only possible but encouraged through adorable, customizable digital stamps. As of today, StampCraft specializes in automatically creating stamps focused on Sushi, a globally beloved Japanese dish, from a single sentence. | ||
|
|
||
| ## How It Works | ||
| ## Use Cases & How It Works | ||
|
|
||
| StampCraft simplifies the process of digital stamp creation and sharing, making it accessible to everyone, regardless of design skills. Here's how it empowers users: | ||
| StampCraft simplifies the creation and sharing of digital stamps: | ||
|
|
||
| 1. **Create Your Stamp**: Utilize our intuitive interface to design your unique digital stamps. No extensive design skills required! | ||
| 2. **Share with the World**: Seamlessly share your creations with the community on Warpcast via the Farcaster protocol. | ||
| 3. **Engage in New Ways**: Use your own stamps or explore others' creations to enrich your digital conversations. | ||
| 1. **Create Your Stamp**: Design unique digital stamps with our user-friendly interface—no advanced design skills needed. | ||
| 2. **Share Globally**: Share your creations via Warpcast using the Farcaster protocol, connecting communities and conversations. | ||
| 3. **Engage & Connect**: Enhance your online interactions with custom stamps, exploring and contributing to a vibrant community. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Intuitive Creation Tool**: Easily design and customize your digital stamps. | ||
| - **Farcaster Protocol Integration**: Leverage the power of Web3 for sharing and utilizing stamps. | ||
| - **Community-Driven**: Join a growing community of artists and communicators. | ||
| - **Cross-Platform Usage**: Use stamps across various platforms, enhancing every message. | ||
| - **Blockchain-Enabled**: Mint your stamps on the blockchain for ownership and sharing. | ||
| - **Ease of Use**: Intuitive design tools accessible to everyone. | ||
| - **Farcaster Integration**: Utilize Web3 technology for sharing and using stamps. | ||
| - **Community-Focused**: Connect with a broad spectrum of artists and communicators. | ||
| - **Versatile Use**: Enhance every message, across various platforms. | ||
| - **Blockchain-Enabled**: Mint stamps for definitive ownership and sharing possibilities. | ||
|
|
||
| ## Technology Stack | ||
|
|
||
| - **Frontend**: Built with React for a dynamic and responsive user experience. | ||
| - **Backend**: Utilizes Node.js for efficient server-side logic and smart contract interactions. | ||
| - **Blockchain**: Smart contracts deployed on Ethereum for stamp ownership and transactions. | ||
| - **Data Storage**: Leveraging Pinata's Farcaster API for reliable data handling. | ||
| - **Frontend**: Developed with NextJS and [frames.js](https://framesjs.org/). | ||
| - **Backend**: Powered by NextJS alongside the OpenAI image generation API. | ||
| - **Deployment**: Hosted on [Vercel](https://vercel.com/). | ||
|
|
||
| ## How It's Made | ||
|
|
||
| StampCraft transcends the traditional boundaries of digital communication by leveraging the advanced capabilities of the OpenAI API, enabling anyone to create delightful digital stamps effortlessly. Operating within the dynamic WarpCast platform as a Frame, StampCraft embodies a fusion of creativity, technology, and user accessibility. | ||
|
|
||
| ### Leveraging OpenAI for Creative Expression | ||
|
|
||
| At the heart of StampCraft's innovative engine lies the OpenAI API, a powerhouse of machine learning models capable of understanding and generating complex images from textual descriptions. This integration allows StampCraft users to transform simple text prompts into charming, visually appealing digital stamps. By harnessing the power of OpenAI's cutting-edge technology, StampCraft ensures that the process of creating unique and engaging stamps is not only possible for everyone but also deeply rewarding and fun. | ||
|
|
||
| ### Crafted Prompts for Delightful Stamps | ||
|
|
||
| The secret sauce to generating these captivating stamps lies in the carefully crafted prompts designed to spark the AI's creativity in specific, user-relatable ways. Recognizing the importance of nuance and context, the StampCraft team has meticulously tailored prompts to encourage the generation of stamps that resonate on a personal level with users. Focusing on universally beloved themes like "Sushi" as a starting point, the prompts are engineered to guide the AI towards creating stamps that are not just cute but also rich in character and emotion. This thoughtful approach to prompt engineering ensures that each stamp is a small work of art, ready to be shared and cherished within the user community. | ||
|
|
||
| ### A Platform for Everyone | ||
|
|
||
| The choice to host StampCraft as a Frame on the WarpCast platform is no coincidence. WarpCast's robust infrastructure and seamless integration capabilities provide the perfect launching pad for StampCraft's innovative features, ensuring a smooth, user-friendly experience. Whether you're a digital communication enthusiast, an artist looking to share your creations, or someone who appreciates the joy of personalized messages, StampCraft welcomes you to explore the limitless possibilities of AI-powered stamp creation. | ||
|
|
||
| In summary, StampCraft stands at the intersection of technology and creativity, offering a platform where anyone can bring their digital communication to life through the power of AI-generated stamps. It's not just about the technology; it's about empowering users to express themselves in new, exciting ways, making every digital interaction a little more personal and a lot more fun. | ||
|
|
||
| # Images | ||
|
|
||
| ## System Overview | ||
|
|
||
| TBD | ||
|
|
||
| ## Screenshots | ||
|
|
||
| TBD | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Embark on your StampCraft journey with these steps: | ||
| To embark on your StampCraft journey, ensure you have set the `OPENAI_API_KEY` in your environment variables. Refer to the [OpenAI API](https://openai.com/blog/openai-api) page for obtaining the `OPENAI_API_KEY`. | ||
|
|
||
| 1. **Clone the Repository**: | ||
| ```bash | ||
| git clone https://github.com/knocks-public/2024-frameworks.git | ||
| ``` | ||
|
|
||
| 2. **Install Dependencies**: | ||
| ```bash | ||
| yarn install | ||
| ``` | ||
| ```bash | ||
| git clone https://github.com/knocks-public/2024-frameworks.git | ||
| ``` | ||
|
|
||
| 3. **Start the Application**: | ||
| ```bash | ||
| yarn dev | ||
| ``` | ||
| 2. **Install Dependencies**: | ||
|
|
||
| 4. Navigate to [http://localhost:3000](http://localhost:3000) in your browser to view the application. | ||
| ```bash | ||
| yarn install | ||
| ``` | ||
|
|
||
| 5. To make edits, modify `app/page.tsx`. | ||
| 3. **Launch the App**: | ||
|
|
||
| 6. For debugging, access [http://localhost:3000/debug](http://localhost:3000/debug). | ||
| ```bash | ||
| yarn dev | ||
| ``` | ||
|
|
||
| 7. (Optional) For real signer usage (incurring warps), copy `.env.sample` to `.env` and populate the environment variables as guided in the comments. | ||
| Then, visit [http://localhost:3000](http://localhost:3000). | ||
|
|
||
| This setup will get the StampCraft application up and running on your local machine for development and trial purposes. | ||
| 4. **Debugging**: Access the debugging tools at [http://localhost:3000/debug](http://localhost:3000/debug). | ||
|
|
||
| ## Deploy | ||
| ## Deployment | ||
|
|
||
| Deploy your application effortlessly: | ||
| Deploy effortlessly with Vercel: | ||
|
|
||
| ```bash | ||
| vercel | ||
| ``` | ||
|
|
||
| ## Contribution | ||
| ## Future Use Cases | ||
|
|
||
| StampCraft aims to facilitate communication using stamps in a manner similar to LINE, enhancing the user experience with a touch of creativity and personalization. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We're excited to welcome contributors to StampCraft! If you have ideas, bug reports, or enhancements, please feel free to submit pull requests or open issues. Let's make StampCraft better, together! | ||
| We invite you to join us in further developing StampCraft! Feel free to propose changes via pull requests or submit issues for new ideas and bug reporting. | ||
|
|
||
| ## License | ||
|
|
||
| StampCraft is proudly open-source and licensed under the MIT License. See [LICENSE](LICENSE) for more information. | ||
| StampCraft is proudly open-source, licensed under the MIT License. See the [LICENSE](LICENSE) for more details. | ||
|
|
||
| # The knocks team | ||
| ## The Team | ||
|
|
||
| - [Shingo Takagi](https://www.linkedin.com/in/shingo-takagi-8a017224a/) - Full Stack Developer | ||
| - [Susumu Tomita](https://www.linkedin.com/in/susumutomita/) - Full Stack Developer | ||
| - [Shingo Takagi](https://www.linkedin.com/in/shingo-takagi-8a017224a/), a visionary Full Stack Developer. | ||
| - [Susumu Tomita](https://www.linkedin.com/in/susumutomita/), an innovative Full Stack Developer. |