Akkuea 🚀🎓

🌟 Welcome to Akkuea

Akkuea is not just a platform—it's a global community redefining the future of education. Powered by open-source technology, AI, and blockchain, Akkuea transforms how knowledge is accessed, created, and shared. Our mission is to make high-quality education free, accessible, and collaborative for everyone, everywhere. 🌍

Join us in building a decentralized educational ecosystem where educators, students, and creators are empowered, rewarded, and connected. Akkuea is a social network with purpose. ✨

📋 Table of Contents

Akkuea 🚀🎓

🎯 Mission & Vision

Mission

To create a collaborative platform where education is free, accessible, and high-quality, built by a diverse and motivated community. We empower those who teach, learn, and share while recognizing the value of every contribution.

Vision

A world where anyone, regardless of background, can access and contribute to a global knowledge library. Akkuea aims to be the leading educational ecosystem for collective, decentralized, and rewarded learning.

🚀 Why Akkuea?

The Problem

📚 Scattered Resources: Educational content is fragmented across platforms, making it hard to find and reuse.
🖼️ Low Quality: Many resources suffer from poor visuals or organization.
💸 Lack of Incentives: Educators and creators often go unrewarded for their efforts.
🌐 Language Barriers: Content is often limited to major languages.
🔒 Proprietary Platforms: Closed systems prioritize profit over impact.

Our Solution

Centralized Hub: A single platform with intelligent filters for educational content by level, language, and format.
AI-Powered Enhancement: Automatic improvements to readability, visuals, and structure.
Transparent Rewards: A Stellar blockchain-based token system that fairly rewards contributions.
Global Access: Automatic translations, multi-format resources, and device compatibility.
Creator Marketplace: Connect directly with designers for personalized resources, paid in tokens.

📚 Key Features

Feature	Description
Centralized Resources	Find and share educational materials in one place.
Rewards for Participation	Earn tokens for contributing value to the community.
AI Visual Enhancement	Enhance documents and images for better educational impact.
Transparent Blockchain	Secure, traceable rewards via Stellar.
Internal Marketplace	Request personalized resources from designers, paid with tokens.
Automatic Translation	Multilingual access for global inclusivity.
Multi-Platform	Fully functional on computers, tablets, and mobiles.
Accessibility	Easy-to-read, multi-format resources for all users.
Open Source	Developers worldwide can contribute to Akkuea’s growth.

👥 Key Users

Educators: Share materials, access peer resources, and earn rewards for contributions.
Students: Discover documents, quizzes, infographics, and join study groups.
Designers & Artists: Create visuals, animations, and multimedia, earning credits and commissions.
AI Assistance: Curates content, translates, simplifies, and enhances resources ethically.

💰 Reward System

Akkuea’s Stellar blockchain powers a transparent incentive system:

Earn Tokens: Publish impactful content and receive tokens based on community engagement.
Bonuses: Consistent contributors gain distinctions and extra rewards.
Traceable Credits: Every AI-enhanced or collaborative resource tracks contributions.
Use Tokens: Access marketplace services or withdraw for external use.

Sharing knowledge = Creating value. That value is now rewarded! 💡

🛠️ Technology Stack

Next.js: Modern, fast, and scalable frontend framework.
Stellar Blockchain: Secure and transparent reward system.
Generative & Analytical AI: Powers translation, image enhancement, and content creation.
Open-Source Development: Community-driven improvement for global collaboration.

🚀 Getting Started

Ready to contribute to the future of education? Follow these steps to get Akkuea running on your local machine.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js: Version 20.11.0 or higher (Download here)
Bun: Version 1.0.25 or higher (Installation guide)
Go: Version 1.24.2 or higher (Download here)
PostgreSQL: Version 13.0 or higher for the backend database (Installation guide)
Git: For version control (Download here)

💡 Tip: We recommend using a version manager like asdf or nvm to manage multiple Node.js versions.

Installation

Clone the repository

git clone https://github.com/akkuea/akkuea.git
cd akkuea

Install dependencies
```
bun install
```

Set up environment variables

For the Go backend:

cd packages/gin
cp env.example .env

Edit the .env file with your database credentials and configuration:

DB_HOST=localhost
DB_USER=your_postgres_user
DB_PASSWORD=your_postgres_password
DB_NAME=akkuea
DB_PORT=5432
JWT_SECRET=your-super-secret-jwt-key-change-this-in-production

Set up the database

Create a PostgreSQL database:
```
createdb akkuea
```
Or using PostgreSQL CLI:
```
CREATE DATABASE akkuea;
```
Start the development servers

From the root directory:
```
bun run dev
```
This will start all services in parallel:
- Frontend: http://localhost:3000
- Go API: http://localhost:8080

Individual Package Development

You can also run individual packages:

# Frontend (Next.js)
cd packages/nextjs
bun run dev

# Go API Backend
cd packages/gin
go run main.go

Docker Setup (Alternative)

If you prefer using Docker:

cd packages/gin
docker-compose up -d

This will start the Go backend with PostgreSQL in containers.

Verification

Once everything is running, you should be able to:

✅ Access the frontend at http://localhost:3000
✅ Make API calls to http://localhost:8080
✅ See database connections working without errors

Common Issues & Troubleshooting

Port conflicts: If ports 3000 or 8080 are already in use, you can modify them in the respective package configurations.

Database connection issues:

Ensure PostgreSQL is running: brew services start postgresql (macOS) or sudo systemctl start postgresql (Linux)
Verify your database credentials in the .env file
Check if the database exists: psql -l

Bun installation issues:

On macOS: curl -fsSL https://bun.sh/install | bash
On Windows: powershell -c "irm bun.sh/install.ps1 | iex"
On Linux: curl -fsSL https://bun.sh/install | bash

Go module issues: Run go mod tidy in the packages/gin directory.

Next Steps

📖 Check out our Contributing Guide for development guidelines
🐛 Report issues on GitHub Issues
💬 Join our Telegram community for support

⚡ Quick Start

For experienced developers who want to get up and running fast:

# Clone and setup
git clone https://github.com/akkuea/akkuea.git
cd akkuea
bun install

# Setup backend environment
cd packages/gin
cp env.example .env
# Edit .env with your database credentials

# Create database
createdb akkuea

# Start all services
cd ../..
bun run dev

Visit http://localhost:3000 to see the frontend and http://localhost:8080 for the API.

🧪 Testing

Running Tests

# Run all tests
bun test

# Frontend tests
cd packages/nextjs
bun test

# Backend tests
cd packages/gin
go test ./...

# Run tests with coverage
go test -cover ./...

Test Structure

Frontend: Jest and React Testing Library for component tests
Backend: Go's built-in testing framework with testify for assertions
Integration: End-to-end tests using Playwright (coming soon)

🔧 Environment Variables

Backend (.env in packages/gin)

Variable	Description	Default	Required
`DB_HOST`	PostgreSQL host	`localhost`	✅
`DB_USER`	Database username	-	✅
`DB_PASSWORD`	Database password	-	✅
`DB_NAME`	Database name	`akkuea`	✅
`DB_PORT`	Database port	`5432`	✅
`JWT_SECRET`	JWT signing secret	-	✅
`PORT`	API server port	`8080`	❌
`STELLAR_NETWORK`	Stellar network (testnet/mainnet)	`testnet`	❌
`AI_API_KEY`	AI service API key	-	❌

Frontend (.env.local in packages/nextjs)

Variable	Description	Default	Required
`NEXT_PUBLIC_API_URL`	Backend API URL	`http://localhost:8080`	✅
`NEXT_PUBLIC_STELLAR_NETWORK`	Stellar network	`testnet`	❌

🔄 Development Workflow

Git Workflow

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/YOUR_USERNAME/akkuea.git

Create a feature branch:

git checkout -b feature/your-feature-name

Make your changes and commit:

git add .
git commit -m "feat: add your feature description"

Push to your fork:

git push origin feature/your-feature-name

Create a Pull Request on GitHub

Commit Convention

We follow Conventional Commits:

feat: New features
fix: Bug fixes
docs: Documentation changes
style: Code style changes
refactor: Code refactoring
test: Adding or updating tests
chore: Maintenance tasks

Code Style

Frontend: ESLint + Prettier configuration
Backend: Go fmt + golangci-lint
Commits: Conventional commits format

Run linting before committing:

# Frontend
cd packages/nextjs
bun run lint

# Backend
cd packages/gin
golangci-lint run

📊 Project Status

🧱 Under active development
We’re building the future of education, and we need your help! Contribute, leave feedback, or simply star the repo to show your support. 🌟

💬 Get Involved

Contribute: Check out our Contributing Guide to get started.
Report Issues: Open an issue on GitHub.
Join the Community: Connect with us on our Telegram group.
Star the Repo: Show your support by starring Akkuea on GitHub! ⭐

🫡 Thanks to Our Contributors

We’re grateful for every contribution that brings us closer to revolutionizing education! 🙌

📜 License

This project is licensed under the MIT License.

Join the educational revolution! 🚀🎓
Happy Learning & Contributing! ✨

Name		Name	Last commit message	Last commit date
Latest commit History 707 Commits
.github/workflows		.github/workflows
.husky		.husky
docs		docs
packages		packages
.gitignore		.gitignore
.prettierrc		.prettierrc
.tool-versions		.tool-versions
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
readme-es.md		readme-es.md

GuiltyCrownne/akkuea

Folders and files

Latest commit

History

Repository files navigation