docs: replace boilerplate readme with project overview
This commit is contained in:
57
README.md
57
README.md
@@ -1,43 +1,32 @@
|
||||
# Astro Starter Kit: Minimal
|
||||
# Lofty Landing Page
|
||||
|
||||
Pre-launch landing page for **The Lofty Project**, a 501(c)(4) connecting creative talent with leftist organizing.
|
||||
|
||||
## Stack
|
||||
|
||||
Astro 5 (static output), TypeScript, Bun
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
bun create astro@latest -- --template minimal
|
||||
bun install # Install dependencies
|
||||
bun run dev # Dev server at localhost:4321
|
||||
bun run build # Static build to dist/
|
||||
bun run preview # Preview production build
|
||||
```
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
## Linting & Formatting
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro project, you'll see the following folders and files:
|
||||
|
||||
```text
|
||||
/
|
||||
├── public/
|
||||
├── src/
|
||||
│ └── pages/
|
||||
│ └── index.astro
|
||||
└── package.json
|
||||
```sh
|
||||
bun run lint # Check for issues
|
||||
bun run lint:fix # Auto-fix issues
|
||||
bun run format # Format all files
|
||||
```
|
||||
|
||||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
|
||||
## Commits
|
||||
|
||||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
|
||||
Uses conventional commits enforced by commitlint + lefthook.
|
||||
|
||||
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 |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `bun install` | Installs dependencies |
|
||||
| `bun dev` | Starts local dev server at `localhost:4321` |
|
||||
| `bun build` | Build your production site to `./dist/` |
|
||||
| `bun preview` | Preview your build locally, before deploying |
|
||||
| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `bun 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
|
||||
bun run commit # Guided commit via commitizen
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user