Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
petrovicz committed Apr 4, 2024
1 parent 012a4c3 commit 274f95e
Showing 1 changed file with 7 additions and 42 deletions.
49 changes: 7 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,12 @@
# Astro Starter Kit: Minimal
# Astro + PhotoSwipe

```sh
npm create astro@latest -- --template minimal
```
[Sample page](https://astro-photoswipe.petrovicz.com/)

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
This is my way of adding PhotoSwipe to Astro, while using Astro's built-in image optimization features.
If you are trying to add PhotoSwipe to an existing Astro project, read my [blog post](https://dev.to/petrovicz/astro-photoswipe-549a).

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
If you are using ViewTransitions, please check out the `viewtransitions` branch.

## 🚀 Project Structure
You think you have a better solution? Feel free to roast me by opening an issue on this repo!

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

```text
/
├── 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: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).
We are all human and prone to mistakes.

0 comments on commit 274f95e

Please sign in to comment.