42 lines
2.5 KiB
Markdown
42 lines
2.5 KiB
Markdown
# Copper Tone Technologies Platform
|
|
|
|
## Overview
|
|
|
|
This repository hosts the code and documentation for the Copper Tone Technologies web platform. Developed by Hopoyuksa Tali Lakna (Amelika Okla Ilemiko), this platform aims to provide a comprehensive digital presence for the company, integrating a public-facing promotional website, an internal work management system, and a client portal with multi-modal payment capabilities.
|
|
|
|
The project is built with a strong emphasis on self-sovereignty, enterprise-grade infrastructure, and leveraging modern technologies including a serverless, blockchain-aware Go backend, a Vue 3 Progressive Web App (PWA) frontend, and extensive use of Podman for containerization.
|
|
|
|
## Key Features
|
|
|
|
* **Promotional Website:** Showcase company services, tribal identity, and expertise.
|
|
* **Work Management System:** Internal tools for scheduling, tracking, and managing in-house and contract work.
|
|
* **Client Portal:** Secure access for clients to view project updates, communicate, and manage invoices/payments.
|
|
* **Advanced Payment Gateway:** Support for traditional credit card processing and cryptocurrency transactions.
|
|
* **Decentralized Data:** Integration with IPFS for resilient and verifiable data storage.
|
|
|
|
## Technology Highlights
|
|
|
|
* **Frontend:** Vue 3 (PWA), Vue Router, Tailwind CSS, Pinia, Helia (IPFS)
|
|
* **Content Management:** Markdown
|
|
* **Backend:** Go 1.25+ (Serverless, Blockchain-integrated, IPFS-interchangeable)
|
|
* **Infrastructure:** Podman, Gitea, Gitea Actions
|
|
* **Database:** PostgreSQL
|
|
* **Communication:** Matrix (Synapse homeserver), Self-hosted Email Server
|
|
|
|
For a more detailed breakdown of the technology stack and architecture, please refer to `GEMINI.md`.
|
|
|
|
## Getting Started
|
|
|
|
Detailed instructions for setting up the development environment, building, and running the application can be found in the project documentation. As this project heavily relies on a containerized environment (Podman), familiarity with container technologies is recommended.
|
|
|
|
## Documentation
|
|
|
|
* **Project Plan:** `docs/project-plan/Plan.md`
|
|
* **Git Workflow:** `docs/project-plan/Git-Workflow.md`
|
|
* **Detailed Phase Plans:** `docs/project-plan/phases/`
|
|
* **Gemini Context:** `GEMINI.md`
|
|
|
|
## Contribution
|
|
|
|
This project follows a strict enterprise-grade Git workflow involving `main`, `testing`, `develop`, and feature branches, with all changes managed via Pull Requests and Gitea Actions. Please consult `docs/project-plan/Git-Workflow.md` for full details.
|