Astro Starter Kit: Nekoweb

(Adapted from the Astro Basics template)

Getting Started

Run this in a terminal to get started.

npm create astro@latest -- --template LelIllumina/Astro-Template

then to start a dev server

npx astro dev

If you are experienced with this and want to install more integrations alongside the base templaate, use the --add flag:

npm create astro@latest -- --template LelIllumina/Astro-Template --add svelte --add mdx --add sitemap

Prerequisites

Note that you will need to have Node.js (or equivalant) installed to use npm and Astro.

To use Deploy2Nekoweb you need to install Git on your system and then push your code to github.
A github action is already configured in /.github/workflows/deploy.yml so you only need to follow the steps related to the api key on the D2N website to automatically upload your built site.

Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src
│   ├── assets
│   │   └── astro.svg
│   ├── components
│   │   └── Head.astro
│   ├── layouts
│   │   └── Layout.astro
│   └── pages
│       └── index.astro
└── package.json

To learn more about the folder structure of an Astro project, refer to our guide on project structure.

Commands

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

Command	Action
npm run 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 Astro's documentation or the Nekoweb Discord server.