Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add Refine tutorial #350

Merged
merged 22 commits into from
Dec 13, 2023
Merged

doc: add Refine tutorial #350

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
dc376b4
docs(tutorials): add refine tutorial
necatiozmen Nov 15, 2023
1626379
docs(quick-start): add refine quick start
necatiozmen Nov 16, 2023
c43d9c0
Merge pull request #1 from appwrite/main
necatiozmen Nov 16, 2023
698839d
Merge branch 'main' into feat-refine-tutorial
necatiozmen Nov 16, 2023
f62a4d3
docs(tutorial): update framework value
necatiozmen Nov 16, 2023
6ea7d1f
docs(tutorial): update Refine svg
necatiozmen Nov 20, 2023
5d54e54
docs(tutorial): update Refine icon
necatiozmen Nov 21, 2023
414c8ea
Merge branch 'main' into feat-refine-tutorial
necatiozmen Nov 27, 2023
d91ef7a
Update src/routes/docs/tutorials/refine/step-2/+page.markdoc
necatiozmen Nov 28, 2023
e6bcfd8
Update src/routes/docs/tutorials/refine/step-2/+page.markdoc
necatiozmen Nov 29, 2023
44b3e89
Update src/routes/docs/tutorials/refine/step-2/+page.markdoc
necatiozmen Nov 29, 2023
0d0d7e3
Update src/routes/docs/tutorials/refine/step-4/+page.markdoc
necatiozmen Nov 29, 2023
f5c17dd
Update src/routes/docs/tutorials/refine/step-4/+page.markdoc
necatiozmen Nov 29, 2023
501ae25
docs(tutorial): update screenshots
necatiozmen Nov 29, 2023
dd9638d
docs(tutorial): update svg's
necatiozmen Nov 29, 2023
cece0dc
docs(tutorial): update indentation & welcome image
necatiozmen Nov 29, 2023
510eea0
docs(tutorial): update code blocks
necatiozmen Nov 29, 2023
4eb829d
docs(tutorial): update code block indentations
necatiozmen Nov 29, 2023
bb0017d
docs(tutorial): update headings
necatiozmen Nov 29, 2023
8be15f4
docs(blog): update Refine icon
necatiozmen Nov 30, 2023
35f65e6
docs(tutorial): update refine svg
necatiozmen Nov 30, 2023
ada55b4
docs(tutorial): update Refine light svg
necatiozmen Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(tutorial): update code blocks
  • Loading branch information
@necatiozmen
necatiozmen committed Nov 29, 2023
commit 510eea03cad4052e10b8562bb869e1a5d86aca84
117 changes: 56 additions & 61 deletions src/routes/docs/tutorials/refine/step-4/+page.markdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,68 +82,63 @@ import { BrowserRouter, Outlet, Route, Routes } from "react-router-dom";
import { appwriteClient } from "./utility";
import { authProvider } from "./authProvider";

const App: React.FC = () => {
return (
<BrowserRouter>
<ConfigProvider theme={RefineThemes.Blue}>
<AntdApp>
<Refine
dataProvider={dataProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
liveProvider={liveProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
authProvider={authProvider}
routerProvider={routerProvider}
notificationProvider={useNotificationProvider}
>
<Routes>
const App: React.FC = () => (
<BrowserRouter>
<ConfigProvider theme={RefineThemes.Blue}>
<AntdApp>
<Refine
dataProvider={dataProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
liveProvider={liveProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
authProvider={authProvider}
routerProvider={routerProvider}
notificationProvider={useNotificationProvider}
>
<Routes>
<Route
element={
<Authenticated fallback={<CatchAllNavigate to="/login" />}>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
></Route>

<Route
element={
<Authenticated fallback={<Outlet />}>
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
</Authenticated>
}
>
<Route
element={
<Authenticated fallback={<CatchAllNavigate to="/login" />}>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
></Route>

<Route
element={
<Authenticated fallback={<Outlet />}>
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
</Authenticated>
}
>
<Route
path="/login"
element={<AuthPage forgotPasswordLink={false} />}
/>
<Route
path="/register"
element={<AuthPage type="register" />}
/>
</Route>

<Route
element={
<Authenticated>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
</Refine>
</AntdApp>
</ConfigProvider>
</BrowserRouter>
);
};
path="/login"
element={<AuthPage forgotPasswordLink={false} />}
/>
<Route path="/register" element={<AuthPage type="register" />} />
</Route>

<Route
element={
<Authenticated>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
</Refine>
</AntdApp>
</ConfigProvider>
</BrowserRouter>
);

export default App;
```
Expand Down
171 changes: 83 additions & 88 deletions src/routes/docs/tutorials/refine/step-6/+page.markdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,101 +261,96 @@ import { appwriteClient } from "./utility";
import { authProvider } from "./authProvider";
import { PostCreate, PostEdit, PostList, PostShow } from "./pages/posts";

const App: React.FC = () => {
return (
<BrowserRouter>
<ConfigProvider theme={RefineThemes.Blue}>
<AntdApp>
<Refine
dataProvider={dataProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
liveProvider={liveProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
authProvider={authProvider}
routerProvider={routerProvider}
resources={[
{
name: "<APPWRITE_COLLECTION_ID>",
list: "/posts",
create: "/posts/create",
edit: "/posts/edit/:id",
show: "/posts/show/:id",
meta: {
label: "Posts",
},
const App: React.FC = () => (
<BrowserRouter>
<ConfigProvider theme={RefineThemes.Blue}>
<AntdApp>
<Refine
dataProvider={dataProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
liveProvider={liveProvider(appwriteClient, {
databaseId: "<APPWRITE_DATABASE_ID>",
})}
authProvider={authProvider}
routerProvider={routerProvider}
resources={[
{
name: "<APPWRITE_COLLECTION_ID>",
list: "/posts",
create: "/posts/create",
edit: "/posts/edit/:id",
show: "/posts/show/:id",
meta: {
label: "Posts",
},
]}
notificationProvider={useNotificationProvider}
options={{
liveMode: "auto",
syncWithLocation: true,
warnWhenUnsavedChanges: true,
}}
>
<Routes>
},
]}
notificationProvider={useNotificationProvider}
options={{
liveMode: "auto",
syncWithLocation: true,
warnWhenUnsavedChanges: true,
}}
>
<Routes>
<Route
element={
<Authenticated fallback={<CatchAllNavigate to="/login" />}>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
>
<Route
index
element={
<Authenticated fallback={<CatchAllNavigate to="/login" />}>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
}
>
<Route
index
element={
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
}
/>

<Route path="/posts">
<Route index element={<PostList />} />
<Route path="create" element={<PostCreate />} />
<Route path="edit/:id" element={<PostEdit />} />
<Route path="show/:id" element={<PostShow />} />
</Route>
</Route>
/>

<Route
element={
<Authenticated fallback={<Outlet />}>
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
</Authenticated>
}
>
<Route
path="/login"
element={<AuthPage forgotPasswordLink={false} />}
/>
<Route
path="/register"
element={<AuthPage type="register" />}
/>
<Route path="/posts">
<Route index element={<PostList />} />
<Route path="create" element={<PostCreate />} />
<Route path="edit/:id" element={<PostEdit />} />
<Route path="show/:id" element={<PostShow />} />
</Route>

</Route>

<Route
element={
<Authenticated fallback={<Outlet />}>
<NavigateToResource resource="<APPWRITE_COLLECTION_ID>" />
</Authenticated>
}
>
<Route
element={
<Authenticated>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
<UnsavedChangesNotifier />
<DocumentTitleHandler />
</Refine>
</AntdApp>
</ConfigProvider>
</BrowserRouter>
);
};
path="/login"
element={<AuthPage forgotPasswordLink={false} />}
/>
<Route path="/register" element={<AuthPage type="register" />} />
</Route>

<Route
element={
<Authenticated>
<ThemedLayoutV2>
<Outlet />
</ThemedLayoutV2>
</Authenticated>
}
>
<Route path="*" element={<ErrorComponent />} />
</Route>
</Routes>
<UnsavedChangesNotifier />
<DocumentTitleHandler />
</Refine>
</AntdApp>
</ConfigProvider>
</BrowserRouter>
);

export default App;
```
Expand Down