-
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
Showing
3 changed files
with
98 additions
and
24 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,2 +1,58 @@ | ||
| # nft-crossing | ||
| Тут должно быть описание | ||
| [🇷🇺 Русская версия](#русская-версия) [🏴 English version (ChatGPT)](#english-version) | ||
|
|
||
| # NFT Crossing | ||
| ## English version | ||
| The application implements NFT crossing functionality, similar to book crossing. The repository contains the complete code of the application for random exchange of NFTs on the TON network. | ||
|
|
||
| > BookCrossing is a hobby and social movement that operates on the principles of social networks and is similar to a flash mob. A person who has read a book leaves ("releases") it in a public place such as a park, cafe, train, library, or subway station, so that another random person can find and read the book. It is expected that the person who finds the book will do the same. The tracking of a book's journey is done through special online services. | ||
| The repository is divided into two parts (packages): the client-side and the "server-side" (smart contract creation). | ||
|
|
||
| ### Server-Side (Smart Contract) | ||
| * Located in the package @nft-crossing/ton. | ||
| * Instructions for building the package can be found at the following link: https://github.com/nft-crossing/nft-crossing/tree/main/packages/ton | ||
| * Technologies used: FunC (Blueprint - https://github.com/ton-org/blueprint) | ||
| * After deploying the smart contract, its address should be added to the client's settings. | ||
|
|
||
| ### Client-Side | ||
| * Located in the package @nft-crossing/tma. | ||
| * Instructions for building the package can be found at the following link: https://github.com/nft-crossing/nft-crossing/tree/main/packages/tma | ||
| * For a more detailed understanding, you can refer to the tutorial: https://ton-community.github.io/tutorials/03-client/ | ||
| * Technologies used: React, Tonconnect (https://github.com/ton-connect/sdk), Tonapi (https://docs.tonconsole.com/tonapi/api-v2)" | ||
|
|
||
| ### Demo | ||
| * Telegram mini app: https://t.me/Nft_crossing_bot/App | ||
| * dApp with Web3 TON auth: https://nft-crossing.github.io/ | ||
|
|
||
| ### Contacts | ||
| * Telegram channel: https://t.me/nft_crossing | ||
| * Github source: https://github.com/nft-crossing/nft-crossing | ||
|
|
||
| ## Русская версия | ||
| Приложение реализует функционал NFT кроссинг - по аналогии с буккроссингом. | ||
| Репозиторий содержит полный код приложения для случайного обмена NFT в сети TON. | ||
|
|
||
| > Буккро́ссинг (англ. BookCrossing), раздача книг, книгообмен или книговоро́т хобби и общественное движение, действующее по принципу социальных сетей и близкое к флешмобу. Человек, прочитав книгу, оставляет («освобождает») её в общественном месте (парк, кафе, поезд, библиотека, станция метро), для того, чтобы другой, случайный человек мог эту книгу найти и прочитать; предполагается, что тот, в свою очередь, повторит это действие. Слежение за «путешествием» книги осуществляется через специальные сервисы в Интернете. | ||
| Репозиторий разделен на две части (packages): клиентскую и "серверную" (создание смарт-контракта) | ||
|
|
||
| ### Серверная часть (смарт-контракт) | ||
| * Содержиться в пакете @nft-crossing/ton | ||
| * Инструкция по сборке пакета, находится по ссылке https://github.com/nft-crossing/nft-crossing/tree/main/packages/ton | ||
| * Технологии: FunC (Blueprint - https://github.com/ton-org/blueprint) | ||
| * После деплоя смарт-контракта, необходимо внести его адрес в настройки клиента | ||
|
|
||
| ### Клиентская часть | ||
| * Содержиться в пакете @nft-crossing/tma | ||
| * Инструкция по сборке пакета, находится по ссылке https://github.com/nft-crossing/nft-crossing/tree/main/packages/tma | ||
| * Для более подробного понимания, можно воспользоваться туториалом https://ton-community.github.io/tutorials/03-client/ | ||
| * Технологии: React, Tonconnect (https://github.com/ton-connect/sdk), Tonapi (https://docs.tonconsole.com/tonapi/api-v2) | ||
|
|
||
|
|
||
| ### Демо | ||
| * Telegram mini app: https://t.me/Nft_crossing_bot/App | ||
| * dApp with Web3 TON auth: https://nft-crossing.github.io/ | ||
|
|
||
| ### Контакты | ||
| * Telegram channel: https://t.me/nft_crossing | ||
| * Github source: https://github.com/nft-crossing/nft-crossing |
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,3 +1,23 @@ | ||
| # NFT Crossing | ||
| [🇷🇺 Русская версия](#русская-версия) [🏴 English version (ChatGPT)](#english-version) | ||
|
|
||
| Тут должно быть описание | ||
| # NFT Crossing - Telegram mini app | ||
|
|
||
| ## English version | ||
| Edit the file src/settings.ts according to your parameters. | ||
|
|
||
| ### Build | ||
| In the console, run the following command: | ||
| ``` | ||
| npm build | ||
| ``` | ||
| As a result, you will get the ready-to-use application in the dist folder, which you will need to deploy on hosting (more details: https://ton-community.github.io/tutorials/03-client/). | ||
|
|
||
| ## Русская версия | ||
| Отредактируйте файл src/settings.ts в соответсвии с вашими параметрами | ||
|
|
||
| ### Билд | ||
| В консоли запустите: | ||
| ``` | ||
| npm build | ||
| ``` | ||
| В итоге в папке dist вы получите готовое приложение, которое будет необходимо разместить на хостинге (подробнее https://ton-community.github.io/tutorials/03-client/) |
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,26 +1,24 @@ | ||
| # nft-crossing | ||
| [🇷🇺 Русская версия](#русская-версия) [🏴 English version (ChatGPT)](#english-version) | ||
|
|
||
| ## Project structure | ||
| # NFT Crossing - Smart Contract | ||
|
|
||
| - `contracts` - source code of all the smart contracts of the project and their dependencies. | ||
| - `wrappers` - wrapper classes (implementing `Contract` from ton-core) for the contracts, including any [de]serialization primitives and compilation functions. | ||
| - `tests` - tests for the contracts. | ||
| - `scripts` - scripts used by the project, mainly the deployment scripts. | ||
| ## English version | ||
| For a better understanding, please refer to this tutorial: https://ton-community.github.io/tutorials/02-contract/ | ||
|
|
||
| ## How to use | ||
| ### Installation/Deployment | ||
| In the console, run the following command: | ||
| ``` | ||
| npm start | ||
| ``` | ||
|
|
||
| ### Build | ||
| and follow the instructions. Ultimately, you will receive the address of your smart contract, which you will need to enter in the settings of the client application. | ||
|
|
||
| `npx blueprint build` or `yarn blueprint build` | ||
| ## Русская версия | ||
| Для лучшего понимания ознакомьтесь с этим туториалом https://ton-community.github.io/tutorials/02-contract/ | ||
|
|
||
| ### Test | ||
|
|
||
| `npx blueprint test` or `yarn blueprint test` | ||
|
|
||
| ### Deploy or run another script | ||
|
|
||
| `npx blueprint run` or `yarn blueprint run` | ||
|
|
||
| ### Add a new contract | ||
|
|
||
| `npx blueprint create ContractName` or `yarn blueprint create ContractName` | ||
| ### Установка/деплой | ||
| В консоли запустите: | ||
| ``` | ||
| npm start | ||
| ``` | ||
| и следуйте инструкциям. В итоге вы получите адрес вашего смарт-контракта, который будет необходимо внести в настройки клиентского приложения. |