docs: init doc framework

amos-project · Oct 23, 2024 · fe7637e · fe7637e
1 parent 3d595f8
commit fe7637e
Show file tree

Hide file tree

Showing 115 changed files with 13,486 additions and 3,134 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,51 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [ "main" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18' # Change this to the node version you need
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Build Website
+        run: yarn workspace amos-website build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './website/build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Amos
 
-Amos is a decentralized state management library, inspired by `redux`, `vuex` and `recoil`.
+A decentralized, data structure-based, fully featured state management library.
 
 ## Highlights
 

diff --git a/apps/examples/README.md b/apps/examples/README.md
diff --git a/apps/examples/src/App.css b/apps/examples/src/App.css
diff --git a/apps/examples/src/App.tsx b/apps/examples/src/App.tsx
diff --git a/apps/examples/src/TodoMVC/TodoMVC.tsx b/apps/examples/src/TodoMVC/TodoMVC.tsx
diff --git a/apps/examples/src/WithStore/WithStore.tsx b/apps/examples/src/WithStore/WithStore.tsx
diff --git a/apps/examples/src/assets/react.svg b/apps/examples/src/assets/react.svg
diff --git a/assets/amos.ico b/assets/amos.ico
diff --git a/assets/amos.png b/assets/amos.png
diff --git a/assets/card.png b/assets/card.png
diff --git a/assets/card.svg b/assets/card.svg
diff --git a/apps/examples/.gitignore → examples/Counter/.gitignore b/apps/examples/.gitignore → examples/Counter/.gitignore
diff --git a/examples/Counter/README.md b/examples/Counter/README.md
@@ -0,0 +1 @@
+# Amos - Counter
diff --git a/apps/examples/index.html → examples/Counter/index.html b/apps/examples/index.html → examples/Counter/index.html
@@ -2,9 +2,9 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <link rel="icon" type="image/svg+xml" href="/amos.svg" />
+  <link rel="icon" type="image/svg+xml" href="../../assets/amos.svg" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Vite + React + TS</title>
+  <title>Amos - Counter</title>
 </head>
 <body>
 <div id="root"></div>

diff --git a/apps/examples/package.json → examples/Counter/package.json b/apps/examples/package.json → examples/Counter/package.json
@@ -1,5 +1,4 @@
 {
-  "name": "amos-examples",
   "private": true,
   "version": "0.0.0",
   "type": "module",

diff --git a/apps/examples/src/Counter/Counter.tsx → examples/Counter/src/App.tsx b/apps/examples/src/Counter/Counter.tsx → examples/Counter/src/App.tsx
@@ -1,10 +1,15 @@
+/*
+ * @since 2024-10-18 23:41:18
+ * @author junbao <[email protected]>
+ */
+
 import { numberBox } from 'amos';
 import { useDispatch, useSelector } from 'amos/react';
-import React from 'react';
+import React, { memo } from 'react';
 
 const countBox = numberBox('count', 0);
 
-export const Counter = () => {
+export const App = memo(() => {
   const dispatch = useDispatch();
   const [count] = useSelector(countBox);
   return (
@@ -13,4 +18,4 @@ export const Counter = () => {
       <button onClick={() => dispatch(countBox.setState((c) => c + 1))}>Click me!</button>
     </div>
   );
-};
+});
diff --git a/apps/examples/src/index.css → examples/Counter/src/index.css b/apps/examples/src/index.css → examples/Counter/src/index.css
diff --git a/apps/examples/src/main.tsx → examples/Counter/src/main.tsx b/apps/examples/src/main.tsx → examples/Counter/src/main.tsx
@@ -1,13 +1,16 @@
+import { createStore } from 'amos-core';
+import { Provider } from 'amos-react';
 import React, { StrictMode } from 'react';
 import { createRoot } from 'react-dom/client';
+import { App } from './App';
 import './index.css';
-import App from './App';
-import { WithStore } from './WithStore/WithStore';
+
+const store = createStore();
 
 createRoot(document.getElementById('root')!).render(
   <StrictMode>
-    <WithStore>
+    <Provider store={store}>
       <App />
-    </WithStore>
+    </Provider>
   </StrictMode>,
 );
diff --git a/apps/examples/src/vite-env.d.ts → examples/Counter/src/vite-env.d.ts b/apps/examples/src/vite-env.d.ts → examples/Counter/src/vite-env.d.ts
diff --git a/apps/examples/vite.config.ts → examples/Counter/vite.config.ts b/apps/examples/vite.config.ts → examples/Counter/vite.config.ts
@@ -1,5 +1,5 @@
-import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
+import { defineConfig } from 'vite';
 
 // https://vitejs.dev/config/
 export default defineConfig({

diff --git a/examples/TodoMVC/.gitignore b/examples/TodoMVC/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?