Cleanup for open-source release.

This commit is contained in:
Holden
2026-06-28 13:23:24 -05:00
parent 9a70089d85
commit 64270eb0ff
4 changed files with 17 additions and 286 deletions

View File

@@ -1,43 +1,26 @@
# Astro Starter Kit: Minimal
# TenWholeYears Web
Landing website for TenWhole Years. Built with Astro and runs on Cloudflare Workers!
## Getting Started
Install dependencies:
```sh
npm create astro@latest -- --template minimal
npm install
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
Create a local `.dev.vars` file:
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
```env
TWY_API_URL=https://api.recroom.baby
TWY_CDN_URL=https://cdn.recroom.baby
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
Start the development server:
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
```sh
npm run dev
```
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).
Astro will print the local URL, by default at `http://localhost:4321`.