Skip to content

Home

Jump to bottom
mandla-enkosi edited this page Apr 5, 2025 · 6 revisions

Welcome to the React API Kit Wiki!

This wiki serves as the central knowledge base for the React API Kit project. Here you'll find detailed specifications, implementation plans, architectural decisions, and contribution guidelines.

Overview

React API Kit aims to provide a focused middleware layer for React and React Native applications. It unifies client-side authentication (JWT, OAuth2/OIDC, Session), token management, robust API communication via Axios, and reliable polling, reducing boilerplate and ensuring consistency across platforms.

Core Documentation

  • React API Kit Specification: The primary specification document detailing the project's goals, architecture, API contracts, security model, and overall design. Start here for a comprehensive understanding.

Implementation Stages

Follow the progress and details of each implementation stage:

  1. Stage 1: Project Setup and Configuration [COMPLETE]
  2. Stage 2: Platform Abstraction Layer
  3. Stage 3: Internal State Management
  4. Stage 4: Core Authentication & Token Management (Unified)
  5. Stage 5: HTTP Client Integration
  6. Stage 6: Polling Service Implementation

(Stages should only be marked as complete once CI is passing successfully)

Development & Contribution

Interested in contributing or setting up the project for development?

  • Contribution Guidelines: Please read our contribution guidelines before submitting issues or pull requests. This covers code style (ESLint/Prettier), commit messages, and the PR process.
  • Development Setup: Refer to the root README.md in the main repository for instructions on installing dependencies and running common commands (npm install, npm test, npm run build, etc.).

Getting Help

  • Bugs & Feature Requests: Please use the GitHub Issues tab in the main repository.
  • Questions: For general questions about the project architecture or implementation, consider opening a discussion thread (if enabled) or contacting the maintainers.

Thank you for your interest in React API Kit!

Clone this wiki locally