website-astro/README.md

61 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-12-28 10:36:15 +01:00
# nardu.in
2022-12-02 11:21:18 +01:00
2022-12-28 10:36:15 +01:00
remade with [astro](https://astro.build)
## Build Setup
```bash
# install dependencies
$ pnpm install
# serve with hot reload at localhost:3000
$ pnpm dev
2022-12-02 11:21:18 +01:00
2022-12-28 10:36:15 +01:00
# build for production as a full static website
$ pnpm build
2022-12-02 11:21:18 +01:00
2022-12-28 10:36:15 +01:00
# launch local server
$ pnpm preview
# deploy
rsync -avz -e 'ssh -p PORT' dist/ user@SERVER_IP:/var/www/FOLDER/dist
```
2022-12-02 11:21:18 +01:00
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
```
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:3000` |
| `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).