Skip to content

Commit

Permalink
added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenbupe committed Aug 16, 2024
1 parent 6dcc4d9 commit 9046d47
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 39 deletions.
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20
61 changes: 22 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,37 @@
# Astro Starter Kit: Basics
# rubenbupe.com

```sh
npm create astro@latest -- --template basics
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
This is a personal portfolio website that showcases my work and projects. It is built using Astro, and inspired by websites like Linear, Resend, Clerk, and others.

> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
The website contains a homepage, and a blog created using Markdown files.

![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
Live website: [https://rubenbupe.com](https://rubenbupe.com)

## πŸš€ Project Structure
## Installation and usage

Inside of your Astro project, you'll see the following folders and files:
1. Install dependencies. I recommend using the node version specified in the `.nvmrc` file:

```text
/
β”œβ”€β”€ public/
β”‚ └── favicon.svg
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ components/
β”‚ β”‚ └── Card.astro
β”‚ β”œβ”€β”€ layouts/
β”‚ β”‚ └── Layout.astro
β”‚ └── pages/
β”‚ └── index.astro
└── package.json
```
npm install
```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
2. Run 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.
```
npm run dev
```

Any static assets, like images, can be placed in the `public/` directory.
## Building the website

## 🧞 Commands
The build process generates a production-ready version of the website that can be served using a static file server.

All commands are run from the root of the project, from a terminal:
1. Create a production build:

| 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 |
```
npm run build
```

## πŸ‘€ Want to learn more?
2. Serve the production build:

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
```
npm run start
```

0 comments on commit 9046d47

Please sign in to comment.