esp8266-react-framework/interface/src/project/DemoInformation.tsx

88 lines
2.9 KiB
TypeScript
Raw Normal View History

2019-07-06 22:56:30 +00:00
import React, { Component } from 'react';
import { Typography, TableRow, TableBody, TableCell, TableHead, Table, Box } from '@material-ui/core';
import { SectionContent } from '../components';
2019-07-06 22:56:30 +00:00
class DemoInformation extends Component {
render() {
return (
<SectionContent title='Demo Information' titleGutter>
2019-07-06 22:56:30 +00:00
<Typography variant="body1" paragraph>
This simple demo project allows you to control the blink speed of the built-in LED.
2019-07-06 22:56:30 +00:00
It demonstrates how the esp8266-react framework may be extended for your own IoT project.
</Typography>
<Typography variant="body1" paragraph>
It is recommended that you keep your project interface code under the 'project' directory.
This serves to isolate your project code from the from the rest of the user interface which should
simplify merges should you wish to update your project with future framework changes.
</Typography>
<Typography variant="body1" paragraph>
2019-08-09 21:33:09 +00:00
The demo project interface code stored in the interface/project directory:
2019-07-06 22:56:30 +00:00
</Typography>
<Table>
2019-07-06 22:56:30 +00:00
<TableHead>
<TableRow>
<TableCell>
File
</TableCell>
<TableCell>
Description
</TableCell>
</TableRow>
</TableHead>
<TableBody>
<TableRow>
<TableCell>
ProjectMenu.tsx
2019-07-06 22:56:30 +00:00
</TableCell>
<TableCell>
You can add your project's screens to the side bar here.
</TableCell>
</TableRow>
<TableRow>
<TableCell>
ProjectRouting.tsx
2019-07-06 22:56:30 +00:00
</TableCell>
<TableCell>
The routing which controls the screens of your project.
</TableCell>
</TableRow>
<TableRow>
<TableCell>
DemoProject.tsx
2019-07-06 22:56:30 +00:00
</TableCell>
<TableCell>
This screen, with tabs and tab routing.
</TableCell>
</TableRow>
<TableRow>
<TableCell>
DemoInformation.tsx
2019-07-06 22:56:30 +00:00
</TableCell>
<TableCell>
The demo information page.
2019-07-06 22:56:30 +00:00
</TableCell>
</TableRow>
<TableRow>
<TableCell>
DemoController.tsx
2019-07-06 22:56:30 +00:00
</TableCell>
<TableCell>
The demo controller tab, to control the built-in LED.
</TableCell>
</TableRow>
2019-07-06 22:56:30 +00:00
</TableBody>
</Table>
<Box mt={2}>
<Typography variant="body1">
See the project <a href="https://github.com/rjwats/esp8266-react/">README</a> for a full description of the demo project.
</Typography>
</Box>
2019-07-06 22:56:30 +00:00
</SectionContent>
)
}
}
export default DemoInformation;