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.

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] Update the tutorial to use Vite instead of create-react-app #8351

Merged
merged 6 commits into from
Nov 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
703 changes: 364 additions & 339 deletions docs/Tutorial.md

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions examples/tutorial/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
45 changes: 22 additions & 23 deletions examples/tutorial/package.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
{
"name": "tutorial",
"version": "4.0.0",
"private": true,
"dependencies": {
"@mui/icons-material": "^5.0.1",
"@mui/material": "^5.0.2",
"ra-data-json-server": "^4.0.0",
"react": "^17.0.0",
"react-admin": "^4.0.0",
"react-dom": "^17.0.0",
"react-scripts": "^5.0.0"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"eject": "react-scripts eject"
},
"browserslist": [
">0.2%",
"not dead",
"not ie <= 11",
"not op_mini all"
]
"name": "tutorial",
"version": "4.0.0",
"private": true,
"type": "module",
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"preview": "vite preview"
},
"dependencies": {
"ra-data-json-server": "^4.5.0",
"react": "^18.2.0",
"react-admin": "^4.5.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/react": "^18.0.22",
"@types/react-dom": "^18.0.7",
"@vitejs/plugin-react": "^2.2.0",
"typescript": "^4.6.4",
"vite": "^3.2.0"
}
}
40 changes: 0 additions & 40 deletions examples/tutorial/public/index.html

This file was deleted.

15 changes: 0 additions & 15 deletions examples/tutorial/public/manifest.json

This file was deleted.

41 changes: 41 additions & 0 deletions examples/tutorial/src/App.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#root {
max-width: 1280px;
margin: 0 auto;
padding: 2rem;
text-align: center;
}

.logo {
height: 6em;
padding: 1.5em;
will-change: filter;
}
.logo:hover {
filter: drop-shadow(0 0 2em #646cffaa);
}
.logo.react:hover {
filter: drop-shadow(0 0 2em #61dafbaa);
}

@keyframes logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}

@media (prefers-reduced-motion: no-preference) {
a:nth-of-type(2) .logo {
animation: logo-spin infinite 20s linear;
}
}

.card {
padding: 2em;
}

.read-the-docs {
color: #888;
}
29 changes: 16 additions & 13 deletions examples/tutorial/src/App.js → examples/tutorial/src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
import * as React from 'react';
import { Admin, Resource } from 'react-admin';
import jsonServerProvider from 'ra-data-json-server';
import PostIcon from '@mui/icons-material/Book';
import UserIcon from '@mui/icons-material/Group';
import { Admin, Resource, ListGuesser } from 'react-admin';
import jsonServerProvider from 'ra-data-json-server';

import { PostList, PostEdit, PostCreate, PostShow } from './posts';
import { PostList, PostEdit, PostCreate } from './posts';
import { UserList } from './users';
import Dashboard from './Dashboard';
import authProvider from './authProvider';
import { Dashboard } from './Dashboard';
import { authProvider } from './authProvider';

const dataProvider = jsonServerProvider('https://jsonplaceholder.typicode.com');

const App = () => (
<Admin
dataProvider={jsonServerProvider(
'https://jsonplaceholder.typicode.com'
)}
authProvider={authProvider}
dataProvider={dataProvider}
dashboard={Dashboard}
>
<Resource
name="posts"
icon={PostIcon}
list={PostList}
edit={PostEdit}
create={PostCreate}
show={PostShow}
icon={PostIcon}
/>
<Resource
name="users"
list={UserList}
icon={UserIcon}
recordRepresentation="name"
/>
<Resource name="users" icon={UserIcon} list={UserList} />
<Resource name="comments" list={ListGuesser} />
</Admin>
);

export default App;
11 changes: 0 additions & 11 deletions examples/tutorial/src/Dashboard.js

This file was deleted.

8 changes: 8 additions & 0 deletions examples/tutorial/src/Dashboard.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { Card, CardContent, CardHeader } from '@mui/material';

export const Dashboard = () => (
<Card>
<CardHeader title="Welcome to the administration" />
<CardContent>Lorem ipsum sic dolor amet...</CardContent>
</Card>
);
15 changes: 15 additions & 0 deletions examples/tutorial/src/MyUrlField.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { useRecordContext } from 'react-admin';
import { Link } from '@mui/material';
import LaunchIcon from '@mui/icons-material/Launch';

const MyUrlField = ({ source }: { source: string }) => {
const record = useRecordContext();
return record ? (
<Link href={record[source]} sx={{ textDecoration: 'none' }}>
{record[source]}
<LaunchIcon sx={{ fontSize: 15, ml: 1 }} />
</Link>
) : null;
};

export default MyUrlField;
1 change: 1 addition & 0 deletions examples/tutorial/src/assets/react.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export default {
export const authProvider = {
// called when the user attempts to log in
login: ({ username }) => {
login: ({ username }: { username: string }) => {
localStorage.setItem('username', username);
// accept all username/password combinations
return Promise.resolve();
Expand All @@ -11,7 +11,7 @@ export default {
return Promise.resolve();
},
// called when the API returns an error
checkError: ({ status }) => {
checkError: ({ status }: { status: number }) => {
if (status === 401 || status === 403) {
localStorage.removeItem('username');
return Promise.reject();
Expand Down
8 changes: 0 additions & 8 deletions examples/tutorial/src/index.js

This file was deleted.

5 changes: 0 additions & 5 deletions examples/tutorial/src/index.module.css

This file was deleted.

7 changes: 0 additions & 7 deletions examples/tutorial/src/logo.svg

This file was deleted.

9 changes: 9 additions & 0 deletions examples/tutorial/src/main.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';

ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
<React.StrictMode>
<App />
</React.StrictMode>
);
80 changes: 0 additions & 80 deletions examples/tutorial/src/posts.js

This file was deleted.

Loading