Skip to content

Commit 5874831

Browse files
committed
update README
1 parent 7e4e9ac commit 5874831

File tree

1 file changed

+25
-39
lines changed
  • examples/kendo-react-e-commerce-astro-app

1 file changed

+25
-39
lines changed
Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,40 @@
1-
# Astro Starter Kit: Basics
1+
## The following KendoReact components are used in the sample application:
22

3-
```sh
4-
npm create astro@latest -- --template basics
5-
```
3+
- [Data Grid](https://www.telerik.com/kendo-react-ui/components/grid/)
64

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
5+
- [Chart](https://www.telerik.com/kendo-react-ui/components/chart/)
106

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
- [ChartWizard](https://www.telerik.com/kendo-react-ui/components/chart-wizard)
128

13-
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
9+
- [DropdownList](https://www.telerik.com/kendo-react-ui/components/dropdowns/dropdownlist)
1410

15-
## 🚀 Project Structure
11+
- [Input](https://www.telerik.com/kendo-react-ui/components/inputs/input)
1612

17-
Inside of your Astro project, you'll see the following folders and files:
13+
- [MaskedTextBox](https://www.telerik.com/kendo-react-ui/components/inputs/maskedtextbox)
1814

19-
```text
20-
/
21-
├── public/
22-
│ └── favicon.svg
23-
├── src/
24-
│ ├── components/
25-
│ │ └── Card.astro
26-
│ ├── layouts/
27-
│ │ └── Layout.astro
28-
│ └── pages/
29-
│ └── index.astro
30-
└── package.json
31-
```
15+
- [Appbar](https://www.telerik.com/kendo-react-ui/components/layout/appbar)
3216

33-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
17+
- [Button](https://www.telerik.com/kendo-react-ui/components/buttons/button)
3418

35-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
19+
- [Form](https://www.telerik.com/kendo-react-ui/components/form)
3620

37-
Any static assets, like images, can be placed in the `public/` directory.
21+
## Prerequisites
3822

39-
## 🧞 Commands
23+
- Node.js [18.17](https://nodejs.org/en) or later.
24+
- macOS, Windows (including WSL), and Linux are supported.
4025

41-
All commands are run from the root of the project, from a terminal:
26+
## Installation
4227

43-
| Command | Action |
44-
| :------------------------ | :----------------------------------------------- |
45-
| `npm install` | Installs dependencies |
46-
| `npm run dev` | Starts local dev server at `localhost:4321` |
47-
| `npm run build` | Build your production site to `./dist/` |
48-
| `npm run preview` | Preview your build locally, before deploying |
49-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50-
| `npm run astro -- --help` | Get help using the Astro CLI |
28+
Run `npm install`
5129

52-
## 👀 Want to learn more?
30+
## Available Scripts
31+
In the project directory, you can run:
5332

54-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
33+
### `npm run build`
34+
Build the application for production usage.
35+
36+
### `npm run dev`
37+
Start a production server.
38+
39+
### `npm run lint`
40+
Check for linting errors.

0 commit comments

Comments
 (0)