Git Product home page Git Product logo

temporal-kyc-poc's Introduction

Temporal KYC System PoC

This is a Proof of Concept (PoC) to evaluate the potential of Temporal for systems requiring multiple types of user interactions.

Development Setup

To set up the local Temporal development environment, follow the instructions at the Temporal Getting Started Guide.

No additional setup is required beyond this.

Running the Application

Open two terminal windows and execute the following commands:

  1. Start the Worker:

    go run src/worker/main.go
  2. Start the Server:

    go run src/server/main.go

APIs

API documentation available in Postman

Project Structure

The directory structure of the project is as follows:

.
├── src 
│   ├── app
│   │   ├── handlers # server APIs
│   │   │   ├── auth.go
│   │   │   └── kyc.go
│   │   ├── kyc_activities # temporal activities
│   │   │   └── send_kyc_notification.go
│   │   ├── kyc_workflows # temporal workflows
│   │   │   ├── kyc_workflow.go
│   │   │   └── request_kyc.go
│   │   ├── models # data models
│   │   │   ├── kyc_request.go
│   │   │   └── user.go
│   │   └── shared.go # shared constants
│   ├── server # server main
│   │   └── main.go
│   └── worker # worker main
│       └── main.go
├── LICENSE
├── README.md
├── go.mod
└── go.sum

Flowchart

alt text

Additional Information

For more information on how Temporal works and its capabilities, please refer to the Temporal Documentation.

If you encounter any issues or have questions, feel free to reach out to the project maintainers.


By following these steps, you should have a working instance of the Temporal KYC System PoC running locally. Enjoy exploring Temporal's capabilities!


License

This project is licensed under the MIT License. See the LICENSE file for more details.

temporal-kyc-poc's People

Contributors

shivam-g10 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.