dashersupply/README.md

56 lines
1.9 KiB
Markdown

# Dasher Supply
> A pretty cool website by [David A. Ball](https://daball.me).
## 🚀 Project Structure
Inside this Astro project, you'll see the following folders and files:
```text
/
├── public/
│ └── assets/
│ │ └── *
│ │ └── brands/
│ │ │ └── *
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── *Card.astro
│ ├── data/
│ │ └── **/*.ts
│ ├── layouts/
│ │ └── *Layout.astro
│ └── pages/
│ └── **/*.astro
│ └── scraper/
│ └── **/*.ts
├── .env
└── package.json
```
You will need to create a `.env` file containing the configuration settings for this app.
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| 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 |
## 👀 Want to learn more?
Feel free to check [the Astro documentation](https://docs.astro.build).