https://github.com/lucjosin/astro-init

A simple boilerplate for Astro project
https://github.com/lucjosin/astro-init

astro astro-js astro-typescript astrojs astrojs-boilerplate typescript

Last synced: 15 days ago
JSON representation

A simple boilerplate for Astro project

• Host: GitHub
• URL: https://github.com/lucjosin/astro-init
• Owner: LucJosin
• Created: 2022-08-21T13:10:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-26T17:13:31.000Z (about 2 years ago)
• Last Synced: 2024-10-09T04:42:18.397Z (about 1 month ago)
• Topics: astro, astro-js, astro-typescript, astrojs, astrojs-boilerplate, typescript
• Language: Astro
• Homepage:
• Size: 102 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to [Astro](https://astro.build) boilerplate

## Usage

- [Fork](https://github.com/LucJosin/astro-init/fork)

- [Download](https://github.com/LucJosin/astro-init/archive/refs/heads/main.zip)

- [Degit](https://github.com/Rich-Harris/degit)

  - ```

    degit LucJosin/astro-init

    ```

## Dependencies

See more Astro [integrations](https://astro.build/integrations/)

- [@astrojs/sitemap](https://www.npmjs.com/package/@astrojs/sitemap)

- [astro](https://www.npmjs.com/package/astro)

- [astro-compress](https://www.npmjs.com/package/astro-compress)

- [eslint](https://www.npmjs.com/package/eslint)

- [prettier](https://www.npmjs.com/package/prettier)

## Commands

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

| Command             | Action                                             |

| :------------------ | :------------------------------------------------- |

| `yarn install`      | Installs dependencies                              |

| `yarn dev`          | Starts local dev server at `localhost:3000`        |

| `yarn build`        | Build your production site to `./dist/`            |

| `yarn preview`      | Preview your build locally, before deploying       |

| `yarn astro ...`    | Run CLI commands like `astro add`, `astro preview` |

| `yarn astro --help` | Get help using the Astro CLI                       |

## Want to learn more?

Feel free check the [documentation](https://docs.astro.build).