Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
filipKovachev committed Nov 18, 2024
1 parent 7e4e9ac commit 5874831
Showing 1 changed file with 25 additions and 39 deletions.
64 changes: 25 additions & 39 deletions examples/kendo-react-e-commerce-astro-app/README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,40 @@
# Astro Starter Kit: Basics
## The following KendoReact components are used in the sample application:

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

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

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

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

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

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

```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```
- [Appbar](https://www.telerik.com/kendo-react-ui/components/layout/appbar)

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

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

Any static assets, like images, can be placed in the `public/` directory.
## Prerequisites

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

All commands are run from the root of the project, from a terminal:
## Installation

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

## 👀 Want to learn more?
## Available Scripts
In the project directory, you can run:

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
### `npm run build`
Build the application for production usage.

### `npm run dev`
Start a production server.

### `npm run lint`
Check for linting errors.

0 comments on commit 5874831

Please sign in to comment.