From edb30dc9b4ec05d5a508d4d08b9ee0fb133a17d5 Mon Sep 17 00:00:00 2001 From: HermanKoii Date: Fri, 18 Apr 2025 11:00:45 -0300 Subject: [PATCH 1/2] Create comprehensive readme_prometheus.md project template documentation --- readme_prometheus.md | 130 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 readme_prometheus.md diff --git a/readme_prometheus.md b/readme_prometheus.md new file mode 100644 index 0000000..a032ab5 --- /dev/null +++ b/readme_prometheus.md @@ -0,0 +1,130 @@ +# Prometheus Project Template + +## Project Overview + +This repository serves as a comprehensive, flexible project template designed to accelerate development by providing a robust, pre-configured starting point for various software projects. It integrates best practices, essential tools, and a scalable architecture to help developers jumpstart their applications with minimal initial setup. + +### Key Features +- ๐Ÿš€ Rapid project initialization +- ๐Ÿ”ง Preconfigured development environment +- ๐Ÿ“ฆ Standardized project structure +- ๐Ÿ›ก๏ธ Built-in code quality and security tools +- ๐ŸŒ Flexible and extensible architecture + +## Getting Started + +### Prerequisites +- Git +- Node.js (v16+ recommended) +- npm or Yarn +- Docker (optional, for containerization) + +### Installation Steps + +1. Clone the repository: +```bash +git clone https://github.com/your-org/prometheus-template.git +cd prometheus-template +``` + +2. Install dependencies: +```bash +npm install +# or +yarn install +``` + +3. Copy environment template: +```bash +cp .env.example .env +``` + +4. Configure environment variables in `.env` + +5. Run the development server: +```bash +npm run dev +# or +yarn dev +``` + +## Customization Guide + +### Renaming the Project +1. Update `package.json`: + - Change `name` + - Modify `description` + - Update `repository` URL + +2. Rename configuration files: + - `.env.example` + - Docker configurations + - CI/CD pipeline scripts + +### Extending the Template +- Modify `src/` directory structure +- Add/remove dependencies in `package.json` +- Customize linting and formatting rules + +## Project Structure + +``` +prometheus-template/ +โ”‚ +โ”œโ”€โ”€ src/ # Main source code +โ”‚ โ”œโ”€โ”€ controllers/ # Request handlers +โ”‚ โ”œโ”€โ”€ models/ # Data models +โ”‚ โ”œโ”€โ”€ routes/ # API route definitions +โ”‚ โ””โ”€โ”€ services/ # Business logic +โ”‚ +โ”œโ”€โ”€ tests/ # Unit and integration tests +โ”œโ”€โ”€ docs/ # Project documentation +โ”œโ”€โ”€ scripts/ # Utility and deployment scripts +โ”‚ +โ”œโ”€โ”€ .env.example # Environment configuration template +โ”œโ”€โ”€ Dockerfile # Container configuration +โ”œโ”€โ”€ docker-compose.yml # Multi-container orchestration +โ””โ”€โ”€ README.md # Project documentation +``` + +## Technologies Used + +### Core Technologies +- ๐Ÿ”ง TypeScript +- ๐Ÿš€ Node.js +- ๐ŸŒ Express.js +- ๐Ÿ’พ MongoDB/PostgreSQL + +### Development Tools +- ๐Ÿงช Jest (Testing) +- ๐Ÿ•ต๏ธ ESLint +- ๐Ÿ’… Prettier +- ๐Ÿณ Docker +- ๐Ÿ” Swagger (API Documentation) + +## Use Cases + +This template is ideal for: +- RESTful API development +- Microservices architecture +- Backend services with authentication +- Rapid prototyping +- Scalable web applications + +## Contributing + +1. Fork the repository +2. Create a feature branch +3. Commit changes with descriptive messages +4. Push to your branch +5. Create a pull request + +Please read `CONTRIBUTING.md` for detailed guidelines. + +## License + +This project is licensed under the MIT License. See `LICENSE` file for details. + +--- + +### ๐ŸŒŸ Happy Coding! ๐ŸŒŸ \ No newline at end of file From c0a01c4db9d988f08ab591f7659f33ce8ba9507d Mon Sep 17 00:00:00 2001 From: HermanKoii Date: Fri, 18 Apr 2025 11:01:44 -0300 Subject: [PATCH 2/2] Update README with comprehensive Prometheus Swarm Bounties project documentation --- readme_prometheus.md | 163 ++++++++++++------------------------------- 1 file changed, 46 insertions(+), 117 deletions(-) diff --git a/readme_prometheus.md b/readme_prometheus.md index a032ab5..e43c2bf 100644 --- a/readme_prometheus.md +++ b/readme_prometheus.md @@ -1,130 +1,59 @@ -# Prometheus Project Template +# Prometheus Swarm Bounties Tracker ๐Ÿš€ ## Project Overview -This repository serves as a comprehensive, flexible project template designed to accelerate development by providing a robust, pre-configured starting point for various software projects. It integrates best practices, essential tools, and a scalable architecture to help developers jumpstart their applications with minimal initial setup. +The Prometheus Swarm Bounties repository is a centralized tracking system for bounty tasks across various open-source projects. It provides a comprehensive view of ongoing bounties, their status, and key project details, facilitating transparency and collaboration in the open-source ecosystem. -### Key Features -- ๐Ÿš€ Rapid project initialization -- ๐Ÿ”ง Preconfigured development environment -- ๐Ÿ“ฆ Standardized project structure -- ๐Ÿ›ก๏ธ Built-in code quality and security tools -- ๐ŸŒ Flexible and extensible architecture +## Features / Capabilities + +- ๐Ÿ“‹ Centralized Bounty Tracking +- ๐Ÿ” Project Repository Linking +- ๐Ÿ’ฐ Bounty Amount Visibility +- ๐Ÿ”— Transaction Hash Recording +- ๐Ÿ“Š Status Monitoring + +## Current Bounties + +| GitHub URL | Bounty Task | Project Name | Description | Bounty Amount | Bounty Type | Transaction Hash | Status | +|------------|------------|--------------|-------------|---------------|-------------|------------------|--------| +| [Koii DumperCoin](https://github.com/alexander-morris/koii-dumper-reveal) | Feature Maker | Koii DumperCoin | Build out the MVP of the wallet analysis tools | 25 | USDC | 0x8f7c7f8d6d17aa4d9671123e28d601c64bdcd91bbc18e5bfd1a4c4fc027ca2f6 | Initialized | +| [Koii Improvement Proposals](https://github.com/koii-network/koii-improvement-proposals) | Feature Maker | KIPs | Review all existing issues on this repo and summarize them as part of the overall readme | 1 | USDC | 0xe8bfeac2b38bc9ae0f4199f09d94669a7bbdd5eaf35fc7b7031dde8b89324d67 | Initialized | ## Getting Started -### Prerequisites -- Git -- Node.js (v16+ recommended) -- npm or Yarn -- Docker (optional, for containerization) - -### Installation Steps - -1. Clone the repository: -```bash -git clone https://github.com/your-org/prometheus-template.git -cd prometheus-template -``` - -2. Install dependencies: -```bash -npm install -# or -yarn install -``` - -3. Copy environment template: -```bash -cp .env.example .env -``` - -4. Configure environment variables in `.env` - -5. Run the development server: -```bash -npm run dev -# or -yarn dev -``` - -## Customization Guide - -### Renaming the Project -1. Update `package.json`: - - Change `name` - - Modify `description` - - Update `repository` URL - -2. Rename configuration files: - - `.env.example` - - Docker configurations - - CI/CD pipeline scripts - -### Extending the Template -- Modify `src/` directory structure -- Add/remove dependencies in `package.json` -- Customize linting and formatting rules - -## Project Structure - -``` -prometheus-template/ -โ”‚ -โ”œโ”€โ”€ src/ # Main source code -โ”‚ โ”œโ”€โ”€ controllers/ # Request handlers -โ”‚ โ”œโ”€โ”€ models/ # Data models -โ”‚ โ”œโ”€โ”€ routes/ # API route definitions -โ”‚ โ””โ”€โ”€ services/ # Business logic -โ”‚ -โ”œโ”€โ”€ tests/ # Unit and integration tests -โ”œโ”€โ”€ docs/ # Project documentation -โ”œโ”€โ”€ scripts/ # Utility and deployment scripts -โ”‚ -โ”œโ”€โ”€ .env.example # Environment configuration template -โ”œโ”€โ”€ Dockerfile # Container configuration -โ”œโ”€โ”€ docker-compose.yml # Multi-container orchestration -โ””โ”€โ”€ README.md # Project documentation -``` - -## Technologies Used - -### Core Technologies -- ๐Ÿ”ง TypeScript -- ๐Ÿš€ Node.js -- ๐ŸŒ Express.js -- ๐Ÿ’พ MongoDB/PostgreSQL - -### Development Tools -- ๐Ÿงช Jest (Testing) -- ๐Ÿ•ต๏ธ ESLint -- ๐Ÿ’… Prettier -- ๐Ÿณ Docker -- ๐Ÿ” Swagger (API Documentation) - -## Use Cases - -This template is ideal for: -- RESTful API development -- Microservices architecture -- Backend services with authentication -- Rapid prototyping -- Scalable web applications - -## Contributing - -1. Fork the repository -2. Create a feature branch -3. Commit changes with descriptive messages -4. Push to your branch -5. Create a pull request - -Please read `CONTRIBUTING.md` for detailed guidelines. +### Bounty Tracking + +1. Review the current list of bounties in the table above +2. Check the status and details of each bounty +3. Visit the linked GitHub repositories for more information + +### Contributing + +- If you want to propose a new bounty, please open an issue in this repository +- For existing bounties, follow the guidelines in the respective project repositories + +## Technologies and Tools + +- ๐Ÿ“Š Markdown for documentation +- ๐Ÿ”— GitHub repository tracking +- ๐Ÿ’ธ Multi-blockchain bounty support (USDC, etc.) + +## Example Bounty Template + +For reference, here's a template for future bounty entries: + +| GitHub URL | Swarm Type | Project Name | Description | Total Bounty Amount | Token Type | Tx Signature | +|------------|------------|--------------|-------------|---------------------|------------|--------------| +| https://github.com/example/repo | Feature Maker | Project Name | Project Description | Amount | Token Type | Transaction Hash | ## License -This project is licensed under the MIT License. See `LICENSE` file for details. +This project is open-source. Please refer to the LICENSE file for more details. + +## Disclaimer + +Bounty details are subject to change. Always verify the latest information directly with the project coordinators. --- -### ๐ŸŒŸ Happy Coding! ๐ŸŒŸ \ No newline at end of file +๐ŸŒŸ **Support Open Source, One Bounty at a Time!** ๐ŸŒŸ \ No newline at end of file