diff --git a/README_Prometheus.md b/README_Prometheus.md new file mode 100644 index 00000000..a02e918a --- /dev/null +++ b/README_Prometheus.md @@ -0,0 +1,82 @@ +# Prometheus: Add README for task-template + +## Project Overview + +This is a comprehensive task template for developing decentralized applications on the Koii Network, providing developers with a robust framework for creating blockchain-based tasks and services. + +### Core Purpose +The template offers a standardized, step-by-step approach to building and deploying distributed computing tasks that can be run across a network of nodes. It simplifies the complex process of creating decentralized applications by providing a structured development environment. + +### Key Features +- Modular task development with predefined stages for setup, core logic, submission, auditing, and reward distribution +- Built-in testing and simulation capabilities for task workflows +- Supports TypeScript development +- Flexible configuration for different task types and complexity levels +- Production-ready deployment process with integrated CLI tools +- Supports manual and automated round management +- Comprehensive error handling and logging mechanisms + +### Benefits +- Rapid prototyping of decentralized applications +- Simplified blockchain task development +- Cross-platform compatibility +- Standardized task execution model +- Built-in incentive engineering support +- Easy integration with Koii Network infrastructure + +## Getting Started, Installation, and Setup + +### Prerequisites + +Before getting started, ensure you have the following installed: +- Node.js (version >=20.0.0, LTS Versions only) +- Yarn package manager + +### Quick Start + +1. Clone the repository: + ```sh + git clone https://github.com/koii-network/task-template.git + cd task-template + ``` + +2. Install dependencies: + ```sh + yarn install + ``` + +### Development Workflow + +#### Running Tests +To test your core task logic: +```sh +yarn test +``` + +#### Simulating Full Task Cycle +To simulate the entire task flow, including task performance, submission, and auditing: +```sh +yarn simulate +``` + +### Building for Production + +1. Build the executable: + ```sh + yarn webpack + ``` + +2. Create a `.env` file by copying `.env.developer.example`: + ```sh + cp .env.developer.example .env + ``` + +3. Debug the production build: + ```sh + yarn prod-debug + ``` + +### Next Steps +- Customize your task logic in `src/task/1-task.js` +- Configure task parameters in `config-task.yml` +- Deploy your task using the Create Task CLI \ No newline at end of file