Skip to content

FLW-TUDO/simba

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Shopfloor Financial Management with Blockchain and AI (SiMBA)

A NestJS-based application.s
🐞 Report Bug · 💡 Request Feature

Table of Contents
  1. 📚 About The Project
  2. 🚀 Getting Started
  3. 🤝 Contributing
  4. 📜 License
  5. 📬 Contact
  6. 🙏 Acknowledgments

📚 About The Project

📄 Description

SiMBA brings financial innovation to the entire production process, from order placement to manufacturing to payment. Leveraging a cyber-physical production system, SiMBA enables dynamic, AI-driven pricing that predicts capacity utilisation and automatically sets prices to balance profitability and system efficiency. Once an order is received and produced, invoices are automatically generated and tokenised based on real-time production data. Finally, SiMBA ensures seamless, use-case-agnostic payment processing via direct debit, stable coins or emerging digital currencies such as CBDCs - making every transaction efficient, transparent and future-proof. You can find detailed documentation in this repository.

🛠️ Built With

  • Angular Framework for building dynamic web applications
  • Docker Platform for containerizing and deploying applications efficiently
  • ESLint Utility for linting and enforcing code quality in JavaScript and TypeScript
  • Hyperledger Besu Ethereum client for enterprise blockchain applications, supporting permissioned and public networks
  • Jest JavaScript testing framework
  • Keycloak Identity and access management solution
  • MinIO S3-compatible object storage
  • NestJS Node.js framework for building scalable server-side applications
  • NFT Folder Blockchain Connector Library for interacting with specific smart contracts from the NFT-Folder project
  • NFT Folder Smart Contracts Smart contracts enabling tokenization, structuring, and secure storage of assets as NFTs on the blockchain
  • Nx Build system for monorepos
  • PostgreSQL Relational database management system known for reliability and performance
  • Prettier Code formatter for consistent style
  • Prisma ORM for database management
  • RabbitMQ Message broker for distributed systems, supporting AMQP
  • Swagger Tools for designing and documenting APIs
  • TypeScript Strongly typed programming language that enhances JavaScript

🏗️ Components Overview

The project consists of the following components:

  1. Backend for frontend (bff)
  • Exposes endpoints for the frontend application.
  • Handles all incoming HTTP requests and routes them to the appropriate services via AMQP.
  • Takes care of the preparation of the data for the Angular frontend.
  1. Master Data Service (master-data-svc)
  • Manages all entities such as companies and products.
  1. Process Service (process-svc)
  • Handles background processes and workflows.
  • Manages the lifecycle of orders, from offer to finished production.
  • Interacts with the database and blockchain to store and retrieve entity data.
  1. Frontend (frontend)
  • Allows users to place orders.

(back to top)

🚀 Getting Started

To set up and run Simba locally, please consult the chapters Deployment View and Tutorial in our documentation. These two chapters provide step-by-step instructions to guide you through the process of installing, configuring and running SIMBA on your local machine.

(back to top)

🤝 Contributing

🌟 Getting Involved

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'Add some amazing-feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

(back to top)

📜 License

Licensed under the Apache License 2.0. See LICENSE for details.

(back to top)

📬 Contact

Leon-Jonathan Krebs: leon.jonathan.krebs@iml.fraunhofer.de

Dominik Sparer: dominik.sparer@iml.fraunhofer.de

(back to top)

🙏 Acknowledgments

  • wait-for-it for providing the wait-for-it.sh script, which is included unmodified in this project under the terms of the MIT License
  • Best-README-Template provided inspiration and structure for creating this README file
  • Img Shields enabled the creation of customizable and visually appealing badges for this project, which is included unmodified in this readme file under the terms of the CC0 1.0 Universal

(back to top)

About

SiMBA (Shopfloor Financial Management with Blockchain and AI)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 91.9%
  • HTML 5.8%
  • SCSS 1.4%
  • Other 0.9%