{"id":31761095,"url":"https://github.com/codemeasandwich/app-data","last_synced_at":"2026-01-20T16:54:55.425Z","repository":{"id":315729867,"uuid":"1059382121","full_name":"codemeasandwich/app-data","owner":"codemeasandwich","description":"React/Webpack - File based state management ","archived":false,"fork":false,"pushed_at":"2025-09-18T11:43:41.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-20T11:35:06.253Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codemeasandwich.png","metadata":{"files":{"readme":"ReadMe.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-18T11:20:35.000Z","updated_at":"2025-09-18T11:43:45.000Z","dependencies_parsed_at":"2025-09-20T11:35:08.660Z","dependency_job_id":"3c66600b-2406-4277-b924-c866e85419fc","html_url":"https://github.com/codemeasandwich/app-data","commit_stats":null,"previous_names":["codemeasandwich/app-data"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/codemeasandwich/app-data","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemeasandwich%2Fapp-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemeasandwich%2Fapp-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemeasandwich%2Fapp-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemeasandwich%2Fapp-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codemeasandwich","download_url":"https://codeload.github.com/codemeasandwich/app-data/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemeasandwich%2Fapp-data/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002050,"owners_count":26083286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-09T21:46:19.546Z","updated_at":"2025-10-09T21:46:23.843Z","avatar_url":"https://github.com/codemeasandwich.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# app-data (aka context-auto)\n\nA file-system based state management library for React that uses convention over configuration to eliminate boilerplate.\n\n## Overview\n\n`context-auto` is a unique state management solution that leverages your project's directory structure to automatically create and wire up state slices, actions, and reducers. Built on React's Context API, it provides a powerful and intuitive developer experience with zero boilerplate.\n\n## Features\n\n- **Zero Boilerplate**: No action types, action creators, or manual store configuration\n- **File-System Based**: Your folder structure defines your state shape and actions\n- **Immutable State**: State exposed via Proxy to prevent accidental mutations\n- **First-Class Async Support**: Built-in handling for async operations with automatic loading states\n- **Lazy Loading**: Support for on-demand data fetching\n- **TypeScript Ready**: Full TypeScript support (if applicable)\n- **Developer Friendly**: Intuitive API that feels natural to use\n\n## Quick Start\n\n### 1. Setup the Provider\n\nWrap your app with the `StateProvider`:\n\n```jsx\n// src/App.js\nimport React from 'react';\nimport { StateProvider } from 'app-data';\nimport MyComponent from './MyComponent';\n\nfunction App() {\n  return (\n    \u003cStateProvider\u003e\n      \u003cMyComponent /\u003e\n    \u003c/StateProvider\u003e\n  );\n}\n\nexport default App;\n```\n\n### 2. Create Your State Structure\n\nOrganize your state using folders. Each folder represents a state slice:\n\n```\n/src\n  /store\n    /user\n      INDEX.js      # Initial state \u0026 reducer\n      login.js      # Synchronous action\n      fetchProfile.js # Async action\n    /cart\n      INDEX.js      # Initial state \u0026 reducer\n      addItem.js    # Synchronous action\n      checkout.js   # Async action\n```\n\n### 3. Use in Components\n\n```jsx\nimport useStore from 'app-data';\n\nfunction MyComponent() {\n  const store = useStore();\n  \n  // Access state\n  const user = store.user;\n  \n  // Call actions\n  const handleLogin = () =\u003e {\n    store.user.login({ username: 'john' });\n  };\n  \n  // Check async loading states\n  const isLoading = store.user.loading.fetchProfile;\n  \n  return (\n    \u003cdiv\u003e\n      \u003ch1\u003eWelcome {user.name}\u003c/h1\u003e\n      {isLoading \u0026\u0026 \u003cspan\u003eLoading...\u003c/span\u003e}\n      \u003cbutton onClick={handleLogin}\u003eLogin\u003c/button\u003e\n    \u003c/div\u003e\n  );\n}\n```\n\n## File Conventions\n\n### INDEX.js - Initial State\n\nEach state slice must have an `INDEX.js` file that exports a default function returning the initial state:\n\n```javascript\n// store/user/INDEX.js\nexport default function() {\n  return {\n    name: '',\n    email: '',\n    isAuthenticated: false\n  };\n}\n```\n\n### Action Files\n\n#### Synchronous Actions\n\nExport a single default function that receives the current state and payload:\n\n```javascript\n// store/user/login.js\nexport default function(state, payload) {\n  return {\n    ...state,\n    name: payload.name,\n    isAuthenticated: true\n  };\n}\n```\n\n#### Asynchronous Actions\n\nExport four named functions to handle async lifecycle:\n\n```javascript\n// store/user/fetchProfile.js\nexport function action(payload) {\n  // Return a promise or undefined to cancel\n  return fetch(`/api/user/${payload.id}`)\n    .then(res =\u003e res.json());\n}\n\nexport function pending(state, payload) {\n  // State while loading\n  return { ...state, loading: true };\n}\n\nexport function fulfilled(state, payload, response) {\n  // State on success\n  return {\n    ...state,\n    ...response,\n    loading: false\n  };\n}\n\nexport function rejected(state, payload, error) {\n  // State on error\n  return {\n    ...state,\n    error: error.message,\n    loading: false\n  };\n}\n```\n\n### Special Files\n\n#### INIT.js - Startup Actions\n\nRuns automatically when the app loads:\n\n```javascript\n// store/user/INIT.js\nexport default async function() {\n  const token = localStorage.getItem('token');\n  if (token) {\n    return await validateToken(token);\n  }\n}\n```\n\n#### DEFER.js - Lazy Loading\n\nFetches data the first time the state slice is accessed:\n\n```javascript\n// store/products/DEFER.js\nexport default async function() {\n  return await fetch('/api/products')\n    .then(res =\u003e res.json());\n}\n```\n\n## Loading States\n\nAsync actions automatically track their loading state:\n\n```javascript\nconst store = useStore();\n\n// Before action is called\nstore.user.loading.save // undefined\n\n// During action\nstore.user.loading.save // true\n\n// After success\nstore.user.loading.save // false\n\n// After error\nstore.user.loading.save // Error object\n\n// Clear loading state\nstore.user.save.clear();\n// or\nstore.user.loading.save.clear();\n```\n\n## Advanced Usage\n\n### Accessing Multiple State Slices\n\n```javascript\nconst store = useStore();\nconst { user, cart, products } = store;\n```\n\n### Conditional Actions\n\n```javascript\nconst store = useStore();\n\nif (!store.user.isAuthenticated) {\n  store.user.login(credentials);\n}\n```\n\n### Error Handling\n\n```javascript\nconst store = useStore();\nconst error = store.user.loading.save;\n\nif (error instanceof Error) {\n  console.error('Save failed:', error.message);\n  error.clear(); // Reset error state\n}\n```\n\n## API Reference\n\n### `\u003cStateProvider\u003e`\nWraps your app to provide state management.\n\n### `useStore()`\nHook that returns the store object with all state slices and actions.\n\n### State Slice Properties\n- Direct access to state values\n- `.loading.[actionName]` - Loading state for async actions\n- Action methods automatically attached\n\n### Action Methods\n- `store.[slice].[action](payload)` - Execute action\n- `store.[slice].[action].clear()` - Clear async action state\n\n## Best Practices\n\n1. Keep state slices focused and single-purpose\n2. Use INIT.js for authentication checks\n3. Use DEFER.js for expensive initial data loads\n4. Name actions descriptively (verb + noun)\n5. Handle errors gracefully in rejected functions\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemeasandwich%2Fapp-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodemeasandwich%2Fapp-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemeasandwich%2Fapp-data/lists"}