From 8c7170862de33459d9f72c1a878b4117d11b32b2 Mon Sep 17 00:00:00 2001 From: Ayvaz Miftakhov Date: Thu, 9 Dec 2021 08:52:21 +0300 Subject: [PATCH] readme edited --- .gitignore | 1 + README.md | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index eec2448c..f4057642 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ package-lock.json src/module/test/* src/services/temp/* src/contracts/tests/utils/__pycache__ +src/contracts/tests/__pycache__ !src/services/temp/.gitkeep .idea .env diff --git a/README.md b/README.md index 9e3d90a3..74b515b5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Nft Collection Node 1 -npm install -npm run build -npm run start \ No newline at end of file +# NFT_collection_distributor +## How to use +1. Clone repository +2. Run `npm install` +3. Go to */src/config/everscale-settings.ts* and set your parameters +4. Run `npm run build` +5. Run `npm run start` +6. Go to *http://localhost:3001/root-contract-form* and configure your future collection settings +7. Press Deploy Contracts button +8. You will Get Deployed Collection and Debot Addresses +9. Source code of your configured Collection and Debot you can find at */results/collections* folder at the folder with the same name as an address of your collection + +## How to run tests +Execute `python -m unittest -v` from */src/contracts/tests* (TestSuite4 required) \ No newline at end of file