Specific section around working with hosting provider

ponderingdemocritus commented 7 months ago

[ ] Detailed example running on slot
[ ] Detailed example of self hosting katana and torii
[ ] Slot CLI reference

juandiegocv27 commented 4 months ago

Hi, I could help with the issue of "Detailed example of self hosting katana and torii", hoping for feedback

ebukizy1 commented 4 months ago

@ponderingdemocritus @glihm can you assign me this issue so i can start working on it immediately

PedroRosalba commented 3 months ago

@ponderingdemocritus @glihm Can i work on this?

Ternder001 commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

My recent focus in Ethereum-Solidity and Starknet-Cairo has significantly deepened my understanding of web3 technologies, positioning me well to contribute to innovative projects in the blockchain space. As an alumnus of Web3Bridge, where I received training in Solidity and Cairo, I have developed a solid foundation in these technologies. I am eager to contribute to open-source projects within the Starknet ecosystem, and I am particularly excited about the opportunity to make meaningful contributions to this project. Given the chance, I am committed to delivering my best work and leveraging my skills to drive success.

How I plan on tackling this issue

To address the problem described in the issue, I would take a structured and methodical approach, breaking down the task into manageable sections. Detailed Example Running on Slot

Firstly, I would create a comprehensive example of a smart contract running on Slot. The initial step involves defining a simple yet illustrative smart contract, such as a token contract or a voting contract, ensuring it demonstrates basic functionalities like deployment, interaction, and querying. Setting up the environment would be the next critical step, where I would provide detailed instructions for installing necessary dependencies like Cairo and Starknet CLI, alongside steps for establishing a local development environment.

Once the environment is ready, I would move on to deploying the smart contract. This would involve writing detailed instructions for compiling and deploying the contract to Slot, complemented by command-line examples and expected outputs to guide users. Interacting with the deployed smart contract comes next, where I would show how to call functions and query the contract's state, again including command-line inputs and expected outputs to ensure clarity. To round off this section, I would include a part dedicated to handling errors and troubleshooting, listing common errors and their solutions, along with tips for debugging issues. Detailed Example of Self-Hosting Katana and Torii

For the second part of the issue, providing a detailed example of self-hosting Katana and Torii, I would start with listing the prerequisites, such as required software and tools like Docker and Node.js, and provide links to their official installation guides. Following this, I would offer step-by-step installation instructions for Katana and Torii, including necessary configuration settings and environment variables.

Setting up the environment would involve demonstrating how to start Katana and Torii and configure them for local development, supported by relevant commands and configuration files. Next, I would provide examples of deploying smart contracts using the self-hosted environment, complete with command-line examples and expected outputs. To ensure users can effectively interact with the environment, I would include detailed examples of calling functions and querying the state, along with common troubleshooting tips and solutions for issues that might arise during setup and usage. Slot CLI Reference

Creating a comprehensive reference guide for the Slot CLI would be the focus of the third part of the issue. I would start with an overview of what the Slot CLI is and its purpose. The guide would then list all available commands, organized by functionality, with detailed descriptions for each. To aid understanding, I would provide usage examples for each command, illustrating common use cases and scenarios.

The guide would also explain all available options and flags for each command, supported by examples showing how to use them effectively. Additionally, I would share tips and best practices for using the Slot CLI, highlighting common patterns and anti-patterns. Lastly, a troubleshooting section would provide solutions for common issues encountered when using the Slot CLI, including tips for debugging and resolving errors. Implementation Plan

The implementation plan involves several key steps. Initially, I would research and gather information, reviewing existing documentation for Slot, Katana, Torii, and Slot CLI to identify gaps and areas needing clarification. Next, I would create detailed guides for each section, testing each step to ensure accuracy and completeness. Once the guides are written, I would review and revise them for clarity and comprehensiveness, incorporating feedback from peers or users.

After the guides are finalized, I would publish them in the appropriate format, such as a documentation site or GitHub repository, and share them with the community to gather further feedback. Maintaining and updating the guides would be an ongoing task, ensuring they remain up-to-date with the latest versions of Slot, Katana, Torii, and Slot CLI, and responding to user feedback to continually improve the documentation.

By following this structured approach, we can create detailed, accurate, and user-friendly guides that help developers effectively use Slot, Katana, Torii, and Slot CLI in their projects.

ScottyDavies commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have a deep understanding of web technologies, including HTML, CSS, and JavaScript. I am well-versed in implementing responsive web design, accessibility best practices, and cross-browser compatibility

How I plan on tackling this issue

I would approach this issue with following steps Running on Slot: Create a step-by-step guide on setting up, deploying, and interacting with Slot-based applications. Include example code, configurations, and best practices. Detailed Example: Self-hosting Katana and Torii: Develop a tutorial on setting up self-hosted Katana and Torii components. Provide instructions on infrastructure, dependencies, and configuration. Slot CLI Reference: Document all Slot CLI commands, their purpose, syntax, and usage examples. Organize the reference for easy navigation and search. Presentation and Documentation: Format the content in a visually appealing and user-friendly manner. Solicit feedback from the Hylé community to continuously improve the resources.

dojoengine / book