Skip to content

Commit

Permalink
added build steps, command section and a very brief overview of Astro…
Browse files Browse the repository at this point in the history
… in the readme file
  • Loading branch information
Aditya Kela committed Nov 28, 2023
1 parent 495ee60 commit 0dcbbff
Showing 1 changed file with 44 additions and 34 deletions.
78 changes: 44 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,64 @@
# Astro Starter Kit: Basics
# Project Website for Q(AI)²
1. This repository is built on top of the
[Astro Framework](https://astro.build/)
2. ```Astro``` requires the ```npm``` ecosystem.
You will need to install ```Node.js```. See here: https://nodejs.org
3. After installing ```Node.js```, clone this repository and run the
following command to install the dependencies:
```sh
npm install
```
4. Next, run the following command to start the development server
in your localhost environment.
The server should start listening on port 4321 (if default).
```sh
npm run dev
```
4. To build to static assets, please run:
```sh
npm run build
```

```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)
## Commands

All commands are run from the root of the project, from a terminal:

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
| 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 |

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

## 🚀 Project Structure
## Project Structure

Inside of your Astro project, you'll see the following folders and files:
The project structure is the following.
Currently, there are no fonts populated in the ```fonts``` folder.
The PDFs folder holds the paper PDFs directly. If papers are linked instead, this folder can be deleted.
Right now, there is one PDF checked into the git repository as it makes it easy to verify across instances.

```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── assets/
│ │ └── fonts/
│ │ └── images/
│ │ └── PDFs
│ ├── components/
│ │ └── Card.astro
│ │ └── Footer.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
│ └── impressum.astro
│ └── datenschutz.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).
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

0 comments on commit 0dcbbff

Please sign in to comment.