Browse Source

Update readme

dev/signature-instant-buy
Lev 2 years ago
parent
commit
2522a1783d
  1. 20
      README.md

20
README.md

@ -1,14 +1,10 @@
# TON Starter Template - Contracts
# Agorata - Contracts
> Starter template for a new TON project - FunC contracts, JS tests, compilation and deployment scripts
> Created from the starter template for a new TON project - FunC contracts, JS tests, compilation and deployment scripts
## Overview
This project is part of a set of 3 typical repositories needed for a blockchain dapp running on TON blockchain:
* Smart contracts in FunC that are deployed on-chain (this repo)
* Web frontend for interacting with the dapp from a web browser (coming soon)
* Telegram bot for interacting with the [dapp from inside Telegram messenger](https://github.com/ton-defi-org/tonstarter-twa)
`main.fc` contains the contract for domains with subdomain support. It is supposed to implement the stadarts for a domain, an NFT collection, and an NFT item.
## What does this repo contain?
@ -52,16 +48,6 @@ Once your local machine is ready, install the project:
* Git clone the repo locally and rename the directory to your own project name
* In the root repo dir, run in terminal `npm install`
### or.. work 100% online instead
Alternatively, you can ignore the above requirements and develop right inside a web browser with an online IDE and *zero* setup. Simply open this repo inside [Glitch](https://glitch.com/) without installing anything:
* Create your new Glitch workspace by opening [this link](https://glitch.com/edit/#!/remix/clone-from-repo?&REPO_URL=https%3A%2F%2Fgithub.com%2Fton-defi-org%2Ftonstarter-contracts.git) in your browser
* Wait about 60 seconds until installation completes <br>(click the "LOGS" button on the bottom of the IDE to see progress)
* Edit your contract files and tests in the online IDE
* To run terminal commands like `npm run build` click the "TERMINAL" button on the bottom of the online IDE
* Working online is slow! run on a local machine if you want a much faster experience
## Development instructions
* Write code

Loading…
Cancel
Save