diff options
| author | Yuval Adam <_@yuv.al> | 2025-05-23 14:52:33 +0200 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2025-05-23 14:52:33 +0200 |
| commit | b400b4fb81b656ec53208c43185ed7887769acc1 (patch) | |
| tree | 5d782171278f70b25bc10f482bc09d414e5b5699 | |
| parent | 3386dfab4ed49ecd00678e2635449f9ba41156d5 (diff) | |
Update readme
| -rw-r--r-- | README.md | 53 |
1 files changed, 10 insertions, 43 deletions
@@ -1,47 +1,14 @@ -# Astro Starter Kit: Minimal +# Astro Base -```sh -npm create astro@latest -- --template minimal -``` - -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) - -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! - -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -├── src/ -│ └── pages/ -│ └── index.astro -└── package.json -``` +A minimal template for new Astro projects. Includes -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +- TypeScript +- Tailwind CSS +- React +- Tailwind Typography -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +## Start a New Project -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 [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +```sh +$ npm create astro@latest new-project -- --template yuvadm/astro-base +```
\ No newline at end of file |
