InkCache – Intelligent Distributed Caching System

Project Description

Abstract InkCache is an advanced InnovateInk infrastructure initiative focused on intelligent distributed caching system. The project aims to create internet-scale systems capable of supporting millions of users while advancing publishing, intelligence, and knowledge infrastructure.

Problem Statement Design and implement intelligent distributed caching system for InnovateInk with scalability, resilience, security, and AI-native capabilities.

Proposed Solution Build a modular architecture using distributed services, APIs, observability, testing, automation, and intelligent decision-making components. Contributors should prioritize original engineering and extensibility.

Tech Stack

Setup Instructions

1. Clone the repository: git clone <repository_url>
2. Navigate to the project directory: cd project-name
3. Install dependencies based on the primary language:
   • Python: pip install -r requirements.txt
   • Node.js/React: npm install
   • Go/Rust: Follow standard build procedures (go build / cargo build)
4. Set up environment variables. Copy .env.example to .env and fill in necessary values.
5. Start the development server (e.g., npm start, python app.py, docker-compose up).

Submission Guidelines

Repository Structure

project-name/
├── README.md
├── docs/
│   ├── architecture.md
│   ├── api-docs.md
│   └── deployment.md
├── src/
├── tests/
├── .github/workflows/
└── demo/
    ├── screenshots/
    └── demo-video-link.md

Naming Conventions

• Repository: cusoc-[year]-[project-code]-[student-uid]
• Branches: feature/, fix/, docs/
• Commit messages: Conventional Commits format (feat:, fix:, docs:)

Coding Standards (Technical Track)

• Linting enforced (ESLint / flake8 / golint)
• All functions documented (docstrings / JSDoc)
• Unit test coverage >= 60%
• No hardcoded secrets; use .env or secrets manager
• Dependencies pinned (requirements.txt, package-lock.json)
• Docker / docker-compose file included
• API endpoints documented (Swagger / OpenAPI or Postman collection)
• All commits linked to issues/tasks

Presentation Requirements

• Duration: 10–15 minutes presentation + 5 minutes Q&A
• Slides: Max 15 slides; must include architecture/methodology, results, and demo
• Demo: Live or pre-recorded; must demonstrate core functionality/impact
• Report: Submitted 48 hours before presentation date
• Audience: Mentor panel + peer cohort

Ethics & Academic Integrity

• All code must be original or properly attributed (OSS licenses respected)
• AI-assisted code must be disclosed and understood by the submitter
• Plagiarism in reports will result in disqualification
• Data collected from communities must be used solely for the stated program purpose
• Students must not misrepresent project outcomes in reports or presentations
• Any partner agreements must not impose obligations beyond the program scope

Contribution Guide

Learning Outcomes for Contributors Distributed systems, API design, security engineering, scalability, DevOps, AI integration, documentation, teamwork, open-source workflows.

Expected Deliverables Functional MVP, architecture diagrams, API endpoints, deployment guide, documentation, benchmark report, unit/integration tests, demo video, open-source repository.