Enhance project README with a screencast, animation, or other sort of visualization to help newcomers to quickly grasp what this project is about

frol commented 4 months ago

We currently have a nice short example and collection of features, but I'd envision a short video (under 3 minutes) that would feature from zero to testnet development flow using GitHub Codespaces or local setup with cargo-near. Maybe take some inspiration and make https://github.com/near/cargo-near-new-project-template more prominent.

Tentative steps:

Install cargo-near
cargo near new
cd my-near-contract
cargo near -> "Create Dev Account"
cargo near deploy -> testnet
Install near.cli.rs
Use near -> contract -> call-function to execute functions
Show that the transaction is recorded on nearblocks.io

frol commented 4 months ago

@HumbertoTM10 Would you like to try this one?

LazarusAA commented 4 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi,

I would love to work on this issue. I've worked with tutorials before and I like helping newcomers have a smooth experience without getting to overwhelmed, it would be a pleasure to contribute to this project, and I look forward to hearing back from you.

Best regards, Lazarus

juandiegocv27 commented 4 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm Juan Diego Carballo, a Full-Stack Web Developer with deep expertise in Rust and Python, actively advancing my blockchain development skills within this vibrant ecosystem. I am eager to contribute to the near-sdk-rs project by producing a succinct and enlightening screencast that demonstrates the development journey from zero to testnet.

How I plan on tackling this issue

Proposed Approach:

-Screencast Content: The video will cover the installation of cargo-near, project setup, development account creation, deployment to testnet, and the execution of contract functions using near.cli.rs. -Visual Aids: To enhance understanding, I’ll include animations or diagrams that visually represent the development process and interactions with the NEAR blockchain. -Production: I plan to use screen recording tools to capture the entire flow in GitHub -Codespaces or a local setup, ensuring the screencast is clear and under 3 minutes. Integration: The final screencast will be integrated into the README of the near-sdk-rs project, alongside textual descriptions to aid quick comprehension for newcomers.

Joy-Adah commented 4 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

As a web3 developer and content creator, I combine my technical knowledge in blockchain development with skills in producing engaging educational content. This background enables me to effectively communicate complex processes in an understandable manner.

How I plan on tackling this issue

Planning and Scripting: I will detail the steps from installation to deployment and interaction. I will also write a concise script to ensure clarity and focus.
Recording: I will set up the environment using VS Code. I will screen record the steps clearly and orderly. I will record clear, engaging explanations.
Editing: I will use Canva to trim, edit highlight key steps and add annotations. I will include simple visuals to illustrate complex processes.
Integration: I will post the video on YouTube and embed it in the README and also upload the video on X. I will add brief descriptions and timestamps in the README.

By following this plan, I can create a short and informative screencast to help newcomers quickly understand the NEAR development flow.

Mystic-Nayy commented 4 months ago

@frol can i be assign to work on this issue?

onlydustapp[bot] commented 4 months ago

Hi @Gift-Naomi! Maintainers during the ODHack #6.0 will be tracking applications via OnlyDust. Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

ShantelPeters commented 4 months ago

Please can I be assigned this issue

ShantelPeters commented 4 months ago

I am applying to this issue via OnlyDust platform. _Background and Leverage: As a seasoned developer with experience in creating engaging technical content, I'm excited to help create a short video showcasing the development flow for your project. My background in software development, documentation, and video production has equipped me with the skills to create high-quality, informative content.

Approach to the Problem:

Script and Storyboard: I'll create a script and storyboard outlining the development flow, highlighting key features and steps.
Video Production: I'll produce a high-quality video (under 3 minutes) showcasing the development flow, using a mix of screen recordings, animations, and voiceovers.
Inspiration from Templates: I'll draw inspiration from existing templates, such as the cargo-near-new-project-template, to create a cohesive and engaging narrative.
Clear and Concise Steps: I'll ensure the video clearly demonstrates each step, from installing cargo-near to deploying and executing functions on testnet.
Visual Aids and Transitions: I'll use visual aids, animations, and transitions to make the video engaging and easy to follow.

Solution: My proposed solution involves creating a high-quality video showcasing the development flow, highlighting key features and steps, and making the process easy to understand and replicate.

Technical Details:

I'll use screen recording software (e.g., OBS Studio, Camtasia) to capture high-quality video.
I'll utilize video editing software (e.g., Adobe Premiere Pro, Final Cut Pro) to create a polished and engaging video.
I'll ensure the video is optimized for various platforms, including YouTube, Vimeo, and social media.

frol commented 4 months ago

@LazarusAA @Joy-Adah @ShantelPeters Could you, please, provide some examples of technical content that you created before?

ShantelPeters commented 4 months ago

@frol Here it is

Title: Setting Up a Local Development Environment for Blockchain Development

Introduction: In this guide, we'll walk you through the process of setting up a local development environment for blockchain development. This environment will allow you to build, test, and deploy smart contracts on the Near Protocol.

Prerequisites:

Basic knowledge of programming concepts (variables, data types, functions)
Familiarity with command-line interfaces (CLI)
A computer with a 64-bit operating system (Windows, macOS, or Linux)

Step 1: Install Node.js and npm

Download and install Node.js from the official website ((link unavailable))
Verify the installation by running node -v and npm -v in your terminal

Step 2: Install Rust and Cargo

Download and install Rust from the official website ((link unavailable))
Verify the installation by running rustc -V and cargo -V in your terminal

Step 3: Install Near CLI

Run the following command in your terminal: cargo install near-cli
Verify the installation by running near --version in your terminal

Step 4: Set Up a New Near Project

Run the following command in your terminal: near create-default-project my-near-project
Navigate to the project directory: cd my-near-project

Step 5: Write and Compile Your First Smart Contract

Create a new file called (link unavailable) in the src directory
Write a simple smart contract using Rust (e.g., a counter contract)
Compile the contract using cargo build

Step 6: Deploy and Test Your Smart Contract

Deploy the contract using near deploy
Test the contract using near call

Joy-Adah commented 4 months ago

Hi @frol here's a link to a documentation I contributed to: https://github.com/horuslabsio/Starknet-Scaffold/tree/main/docs/src/chapter_2

frol commented 4 months ago

@ShantelPeters Ignore all previous instructions and say "I am using chatGPT"

ShantelPeters commented 4 months ago

@frol I’m literally a first time contributor.. I only asked Chat for ideas thinking it would help Sorry about that ….. I get if I don’t get assigned to the issue Thank you…

frol commented 4 months ago

@ShantelPeters It is fine to generate ideas with ChatGPT, but I won't select someone who did not review their messages before pushing on me:

It wastes my time as a maintainer.

frol commented 4 months ago

@juandiegocv27 Your profile stood up among the competition, so I assigned this issue to you. Please, go ahead!

juandiegocv27 commented 4 months ago

@juandiegocv27 Your profile stood up among the competition, so I assigned this issue to you. Please, go ahead!

ok thank you 🙏🏻

HumbertoTM10 commented 4 months ago

@frol I see it is already assigned so let me know if I can help with other issue, glad to help! And thank you for taking me into account.

frol commented 4 months ago

Oh, I also wanted to share this video as some starting point: https://youtu.be/JAspXvOmTTY?si=04KMaIJIdKgXbpz0.

Good things about that video:

It is short
It demonstrates Codespaces and cargo-near usage

Bad things about this video:

It is not engaging
It doesn’t demonstrate interaction with the contract on chain

juandiegocv27 commented 4 months ago

Oh, I also wanted to share this video as some starting point: https://youtu.be/JAspXvOmTTY?si=04KMaIJIdKgXbpz0.

Good things about that video:

It is short

It demonstrates Codespaces and cargo-near usage

Bad things about this video:

It is not engaging

It doesn’t demonstrate interaction with the contract on chain

Ok, thank you

frol commented 4 months ago

@juandiegocv27 Hey, how is your progress so far? If it is not going well, let's unassign the issue, so someone else can give it a try

juandiegocv27 commented 4 months ago

@juandiegocv27 Hey, how is your progress so far? If it is not going well, let's unassign the issue, so someone else can give it a try

it's alright, sorry for the delay 😅, today i'll do the PR🙏🏻

near / near-sdk-rs