firq-dev-website/README.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

# Welcome to Firqs FGO Site
2023-01-15 16:41:38 +00:00
This is build using [Astro](https://astro.build)
2023-01-15 16:41:38 +00:00
2023-01-15 16:56:17 +00:00
## 🚀 Project Structure
2023-01-15 16:41:38 +00:00
```
2023-01-15 16:56:17 +00:00
/
├── static/
│ ├── favicon.svg
│ └── other files ...
2023-01-15 16:56:17 +00:00
├── src/
│ ├── components/
│ │ ├── servantCard.astro
│ │ ├── ceCard.astro
│ │ ├── contactCard.astro
│ │ └── taCard.astro
│ │
2023-01-15 16:56:17 +00:00
│ ├── layouts/
│ │ ├── customFooter.astro
│ │ ├── baseSection.astro
│ │ ├── taSection.astro
│ │ ├── contactSection.astro
2023-01-15 16:56:17 +00:00
│ │ └── Layout.astro
│ │
2023-01-15 16:56:17 +00:00
│ └── pages/
│ └── index.astro
├── .gitlab-ci.yml
├── astro.config.mjs
2023-01-15 16:56:17 +00:00
└── package.json
2023-01-15 16:41:38 +00:00
```
2023-01-15 16:56:17 +00:00
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
2023-01-15 16:41:38 +00:00
More routes will follow soon
2023-01-15 16:41:38 +00:00
Any static assets, like images, can be placed in the `static/` directory.
2023-01-15 16:41:38 +00:00
## 🧞 Astro-Specific Commands
2023-01-15 16:41:38 +00:00
2023-01-15 16:56:17 +00:00
All commands are run from the root of the project, from a terminal:
2023-01-15 16:41:38 +00:00
2023-01-15 16:56:17 +00:00
| Command | Action |
| :--------------------- | :------------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `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 preview` |
| `npm run astro --help` | Get help using the Astro CLI |
2023-01-15 16:41:38 +00:00