{"id":21171828,"url":"https://github.com/ileskov/family","last_synced_at":"2025-07-16T01:14:50.521Z","repository":{"id":52995927,"uuid":"520099552","full_name":"ILESKOV/Family","owner":"ILESKOV","description":"Contract allows users to mint standard ERC721 tokens of type MAN or WOMAN,  after that, the user can create a KID token, when the KID token reaches maturity, they become adults MAN or WOMAN token","archived":false,"fork":false,"pushed_at":"2022-10-19T23:08:54.000Z","size":821,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-06T03:50:54.543Z","etag":null,"topics":["collection","crypto","cryptocurrency","erc721","nft","smart-contracts","solidity"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ILESKOV.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-01T12:23:54.000Z","updated_at":"2022-11-14T01:20:57.000Z","dependencies_parsed_at":"2023-01-20T16:00:34.075Z","dependency_job_id":null,"html_url":"https://github.com/ILESKOV/Family","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FFamily","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FFamily/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FFamily/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FFamily/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ILESKOV","download_url":"https://codeload.github.com/ILESKOV/Family/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225587735,"owners_count":17492633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collection","crypto","cryptocurrency","erc721","nft","smart-contracts","solidity"],"created_at":"2024-11-20T16:12:42.801Z","updated_at":"2024-11-20T16:12:43.406Z","avatar_url":"https://github.com/ILESKOV.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 👪 'Family' NFT collection 👫\n\u003e There is one contract Family.sol with ERC721 standard implementation. Collection has 4 types of tokens: MAN, WOMAN, KID_BOY and KID_GIRL\n\n\n## 📁 Table of Contents\n* [General Info](#-general-information)\n* [Technologies Used](#-technologies-used)\n* [Features](#-features)\n* [Requirements For Initial Setup](#-requirements-for-initial-setup)\n* [Setup](#-setup)\n* [Contact](#-contact)\n\n\n\n## 🚩 General Information\n- Contract allows users to mint standard ERC721 tokens of type MAN or WOMAN with mintHuman() function\n- If the user has both MAN and WOMAN tokens he can create a KID token with breeding() function\n- In the contract each real day is equal to one year and the owner can set the maturity age\n- When the KID token reaches maturity age and its checked via checkAgeChanging() function this token become adult MAN or WOMAN token\n\n \n## 💻 Technologies Used\n- hh coverage\n- slither\n- docgen\n- solhint\n\n## 🌟 Features\n- Users could create 'Family'\n- Owner set all variables: mint price, maturity age etc.\n- 100% coverage of tests\n\n## 👀 Requirements For Initial Setup\n- Install [NodeJS](https://nodejs.org/en/), should work with any node version below 16.16.0\n- Install [Hardhat](https://hardhat.org/)\n\n## 📟 Setup\n### 1. 💾 Clone/Download the Repository\n### 2. 📦 Install Dependencies:\n```\n$ cd repository_file\n$ npm install\n```\n### 3. 🔍  .env environment variables required to set up\nCreate .env file inside project folder\n- You can get your ethereum or testnet API key [here](https://infura.io/dashboard/ethereum),[here](https://www.alchemy.com) or any other service that allow you to connect to the nodes\n- You can get your private key from your wallet(⚠️Don't share your private key with untrusted parties) \n- You can get your etherscan API -key [here](https://etherscan.io/myapikey).\n```\nGOERLI_API = \u003cgoerli API key\u003e\nMAINNET_API = \u003cEthereum mainnet API key\u003e\nPRIVATE_KEY = \u003cPrivate key of your wallet u want to deploy contracts from\u003e\nETHERSCAN_KEY = \u003cEtherscan API key in order to verify your contracts\u003e\nMINT_PRICE = \u003cConstructor parameter mint price in ETH in wei(example: 0.05 ETH = 50000000000000000 wei)\u003e\nMAX_SUPPLY = \u003cConstructor parameter max limit of tokens to be minted\u003e\nMATURITY_AGE = \u003cConstructor parameter age when token will change from KID type to ADULT type\u003e\n```\n\n\u003c!--![Example screenshot](./helpers/Screenshot8.png)--\u003e\n\n### 4. ⚠️  Run Tests\n```\n$ npm run test\n```\n\n```\n$ npm run coverage\n```\n\n### 5. 🚀 Deploy and verify on Goerli, Polygon or Mainnet\n\n```\n$ npm run goerli\n``` \n```\n$ npm run polygon\n``` \n```\n$ npm run mainnet\n``` \n\n### Note: \n\ndeploy.ts implements the verification script and you don't need to complete any additional steps in order to verify the contract.\n\n\n## 💬 Contact\nCreated by [@LESKOV](https://www.linkedin.com/in/ivan-leskov-4b5664189/) - feel free to contact me!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fileskov%2Ffamily","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fileskov%2Ffamily","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fileskov%2Ffamily/lists"}