{"id":27285362,"url":"https://github.com/aswinr24/crediflow","last_synced_at":"2025-04-11T19:23:46.774Z","repository":{"id":252133472,"uuid":"839463673","full_name":"Aswinr24/CrediFlow","owner":"Aswinr24","description":"Where Financial Flow Meets Operational Excellence","archived":false,"fork":false,"pushed_at":"2024-12-21T14:32:48.000Z","size":9667,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T19:23:40.511Z","etag":null,"topics":["defi","ipfs","tyoescript","web3"],"latest_commit_sha":null,"homepage":"https://web3ssh.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Aswinr24.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-07T16:55:41.000Z","updated_at":"2024-12-21T17:32:54.000Z","dependencies_parsed_at":"2024-12-21T09:35:15.965Z","dependency_job_id":null,"html_url":"https://github.com/Aswinr24/CrediFlow","commit_stats":null,"previous_names":["aswinr24/web3ssh","aswinr24/crediflow"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aswinr24%2FCrediFlow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aswinr24%2FCrediFlow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aswinr24%2FCrediFlow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aswinr24%2FCrediFlow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aswinr24","download_url":"https://codeload.github.com/Aswinr24/CrediFlow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248465334,"owners_count":21108244,"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":["defi","ipfs","tyoescript","web3"],"created_at":"2025-04-11T19:23:46.032Z","updated_at":"2025-04-11T19:23:46.743Z","avatar_url":"https://github.com/Aswinr24.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CrediFlow\n\nCrediFlow transforms supply chain finance by eliminating inefficiencies, enhancing transparency, and building trust.It streamlines buyer-supplier interactions, secures digital payments, and ensures seamless document management with decentralized storage. CrediFlow brings speed, security, and simplicity to supply chain operations.\n\n\n## Key Features  \n\n- 🏗️ **Direct Buyer-Supplier Interaction**  \n  Eliminate intermediaries by enabling direct communication between buyers and suppliers, streamlining processes, and reducing third-party reliance.  \n\n- ⚙️ **Comprehensive Functionality**  \n  Supports a variety of supply chain use cases, including:  \n  - 📑 Purchase ordering  \n  - 💸 Dynamic discounting  \n  - 🌍 Cross-border trading  \n  - 🛡️ Supplier risk assessment  \n\n- 🔒 **Secure Digital Payments**  \n  Implements an escrow system to ensure safe and reliable cryptocurrency transactions, mitigating fraud risks.  \n\n- ⚡ **Fast and Cost-Effective Transactions**  \n  Facilitates quick and low-cost digital payments using cryptocurrencies or digital tokens.  \n\n- 📂 **Decentralized Document Storage**  \n  Leverages IPFS services like lighthouse.storage to securely store and share documents, ensuring data integrity and accessibility.  \n\n\n## Architecture / WorkFlow\n\nLet us consider an example use case here, PURCHASE ORDERING\n\n![image](https://github.com/user-attachments/assets/2cc049eb-38a8-451d-b577-409c0431c81e)\n\n![image](https://github.com/user-attachments/assets/dd1ccc86-86df-4160-9bdc-934bcc585a38)\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have the following installed:\n\n- Node.js (v16 or higher)\n- npm package manager\n- A compatible crypto wallet (e.g., MetaMask/Phantom)\n\n  \n### Installation\n\nClone the repository:\n\n```bash\ngit clone https://github.com/Aswinr24/CrediFlow.git\n```\n\nNavigate to the project directory:\n```bash\ncd CrediFlow\n```\n\nInstall dependencies:\n```bash\nnpm i\n```\n\n#### Environment Setup\n\nCreate a .env file in the root directory and configure the following variables:\n\n```env\nNEXT_PUBLIC_CONTRACT1_ADDRESS=\u003cdeployed-contract1-address\u003e\nNEXT_PUBLIC_CONTRACT2_ADDRESS=\u003cdeployed-contract2-address\u003e\nNEXT_PUBLIC_SERVER_URL=\u003curl-of-backend-server-running-app.js\u003e\nNEXT_PUBLIC_PROJECT_ID=\u003cwallet-connect-project-id\u003e\nLIGHTHOUSE_API_KEY=\u003cyour-lighthouse-api-key\u003e\n```\n\n#### Run Locally\n\nStart the development server for UI:\n\n```bash\nnpm run dev\n```\n\nStart the backend server for IPFS Storage APIs:\n\n```bash\nnode app.js\n```\n\n#### Build for Production\n\nBuild the application for production:\n\n```bash\nnpm run build\nnpm start\n```\n\n### Smart Contracts Deployment\n\nNavigate to the Contracts Directory\n\n```bash\ncd Crediflow_contracts \n```\n\nInstall Dependencies for Hardhat\n\n```bash\nnpm i\n```\n\n#### Environment Setup for Smart Contracts\n\nCreate a .env file in the contracts directory and configure the following variables:\n\n```env\nAPI_KEY=\u003cYOUR_ALCHEMY_API_KEY\u003e\nPRIVATE_KEY=\u003cYOUR_WALLET_PRIVATE_KEY\u003e\n```\n\n#### Compile Smart Contracts\n\nCompile the smart contracts using Hardhat:\n\n```bash\nnpx hardhat compile\n```\n#### Deploy Smart Contracts\n\nDeploy the contracts to the Polygon zkEVM cardona test network:\n\n```\nnpx hardhat run scripts/deploy.js --network zkEVMTestnet\n```\n\n#### Update Contract Address\n\nAfter deploying the smart contracts, note the contract addresses and update the ```NEXT_PUBLIC_SMART_CONTRACT1_ADDRESS``` and ```NEXT_PUBLIC_CONTRACT2_ADDRESS``` variables in the .env file of the UI directory.\n\n## Contributing\n\nContributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or clone the repository and submit a pull request on GitHub.\n\nFor detailed guidelines on how to contribute, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file  \n\n## License\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE) for more details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faswinr24%2Fcrediflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faswinr24%2Fcrediflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faswinr24%2Fcrediflow/lists"}