6f28146ac3
- Complete project structure with Next.js frontend - GraphQL API backend with Apollo Server - Portal application with NextAuth - Crossplane Proxmox provider - GitOps configurations - CI/CD pipelines - Testing infrastructure (Vitest, Jest, Go tests) - Error handling and monitoring - Security hardening - UI component library - Documentation
140 lines
3.2 KiB
Markdown
140 lines
3.2 KiB
Markdown
# Phoenix Sankofa Cloud
|
|
|
|
**The sovereign cloud born of fire and ancestral wisdom.**
|
|
|
|
## Overview
|
|
|
|
Phoenix Sankofa Cloud is a next-generation, sovereign AI cloud infrastructure platform that combines:
|
|
|
|
- **Mythic Power**: Phoenix transformation and rebirth
|
|
- **Ancestral Wisdom**: Sankofa memory and return
|
|
- **Cultural Identity**: Akan heritage and sovereignty
|
|
- **Global Reach**: 325-region deployment
|
|
- **Technical Excellence**: World-class cloud infrastructure
|
|
|
|
## Tech Stack
|
|
|
|
### Frontend
|
|
- **Next.js 14+** (React + TypeScript)
|
|
- **TailwindCSS** + **shadcn/ui** for styling
|
|
- **Framer Motion** for animations
|
|
- **React Flow** for graph editing
|
|
- **react-three-fiber** + **drei** for 3D visualizations
|
|
- **ECharts** for dashboards
|
|
- **TanStack Query** for data fetching
|
|
|
|
### Backend (Planned)
|
|
- **GraphQL API** (Hasura/Postgres or Neo4j)
|
|
- **WebSockets** for real-time updates
|
|
- **PostgreSQL** for core data
|
|
- **Neo4j** (optional) for complex graph queries
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Node.js 18+
|
|
- pnpm (recommended) or npm/yarn
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Run development server
|
|
pnpm dev
|
|
|
|
# Build for production
|
|
pnpm build
|
|
|
|
# Start production server
|
|
pnpm start
|
|
```
|
|
|
|
### Development
|
|
|
|
```bash
|
|
# Type checking
|
|
pnpm type-check
|
|
|
|
# Linting
|
|
pnpm lint
|
|
|
|
# Formatting
|
|
pnpm format
|
|
|
|
# Testing
|
|
pnpm test
|
|
pnpm test:coverage
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
Create a `.env.local` file in the root directory with the following variables:
|
|
|
|
```env
|
|
# GraphQL API
|
|
NEXT_PUBLIC_GRAPHQL_ENDPOINT=/api/graphql
|
|
|
|
# Application
|
|
NEXT_PUBLIC_APP_URL=http://localhost:3000
|
|
NODE_ENV=development
|
|
|
|
# Monitoring (optional)
|
|
NEXT_PUBLIC_SENTRY_DSN=
|
|
SENTRY_AUTH_TOKEN=
|
|
|
|
# Analytics (optional)
|
|
NEXT_PUBLIC_ANALYTICS_ID=
|
|
```
|
|
|
|
See the portal README for portal-specific environment variables.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
Sankofa/
|
|
├── docs/ # Documentation
|
|
│ ├── brand/ # Brand documentation
|
|
│ └── architecture/ # Technical architecture
|
|
├── src/
|
|
│ ├── app/ # Next.js app router pages
|
|
│ ├── components/ # React components
|
|
│ │ ├── ui/ # UI components (shadcn/ui)
|
|
│ │ ├── 3d/ # 3D visualization components
|
|
│ │ ├── dashboards/ # Dashboard components
|
|
│ │ ├── editors/ # Graph/flow editors
|
|
│ │ └── well-architected/ # WAF components
|
|
│ ├── lib/ # Utilities and helpers
|
|
│ ├── styles/ # Global styles
|
|
│ └── content/ # Content files
|
|
├── public/ # Static assets
|
|
│ └── brand/ # Brand assets
|
|
└── package.json
|
|
```
|
|
|
|
## Brand Philosophy
|
|
|
|
Phoenix Sankofa Cloud is built on the principle of **Remember → Retrieve → Restore → Rise**:
|
|
|
|
- **Remember**: Where we came from
|
|
- **Retrieve**: What was essential
|
|
- **Restore**: Identity and sovereignty
|
|
- **Rise**: Forward with purpose
|
|
|
|
## Documentation
|
|
|
|
See the `/docs` directory for:
|
|
- Brand philosophy and positioning
|
|
- Product naming system
|
|
- Technical architecture
|
|
- Well-Architected Framework approach
|
|
|
|
## License
|
|
|
|
[To be determined]
|
|
|
|
---
|
|
|
|
**Phoenix Sankofa Cloud** — Remember. Retrieve. Restore. Rise.
|