Skip to content

Commit f114b50

Browse files
committed
feat: add README
1 parent c18b939 commit f114b50

1 file changed

Lines changed: 7 additions & 42 deletions

File tree

README.md

Lines changed: 7 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,12 @@
1-
# Astro Starter Kit: Minimal
1+
# devarsh-website
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
3+
This is my personal website built with Astro! Go to [devarsh.me](https://devarsh.me) to check it out.
64

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
5+
## Setup
106

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
You will need [Bun](https://bun.sh) installed.
128

13-
## 🚀 Project Structure
9+
1. Install dependencies with `bun install --frozen-lockfile`
10+
2. Run `bun run dev` to start the development server
1411

15-
Inside of your Astro project, you'll see the following folders and files:
16-
17-
```text
18-
/
19-
├── public/
20-
├── src/
21-
│ └── pages/
22-
│ └── index.astro
23-
└── package.json
24-
```
25-
26-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
27-
28-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
29-
30-
Any static assets, like images, can be placed in the `public/` directory.
31-
32-
## 🧞 Commands
33-
34-
All commands are run from the root of the project, from a terminal:
35-
36-
| Command | Action |
37-
| :------------------------ | :----------------------------------------------- |
38-
| `npm install` | Installs dependencies |
39-
| `npm run dev` | Starts local dev server at `localhost:4321` |
40-
| `npm run build` | Build your production site to `./dist/` |
41-
| `npm run preview` | Preview your build locally, before deploying |
42-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
43-
| `npm run astro -- --help` | Get help using the Astro CLI |
44-
45-
## 👀 Want to learn more?
46-
47-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
12+
The site is deployed on Cloudflare Pages. You can get the files to deploy with `bun run build`. If you want to change the adapter, you can do so following the official Astro documentation for the adapter you want.

0 commit comments

Comments
 (0)