An open API service indexing awesome lists of open source software.

https://github.com/ngodingbang/learning-astro

Learning project to learn Astro framework.
https://github.com/ngodingbang/learning-astro

Last synced: 5 months ago
JSON representation

Learning project to learn Astro framework.

Awesome Lists containing this project

README

          

# NgodingBang Learning Astro

[![License](https://shields.io/github/license/ngodingbang/learning-astro 'License')](LICENSE.md)

Learning Astro is a learning project to learn Astro framework.

## Table of Contents

- [NgodingBang Learning Astro](#ngodingbang-learning-astro)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Commands](#commands)
- [Author](#author)
- [Changelog](#changelog)
- [License](#license)

## Requirements

- [![Node.js](https://img.shields.io/badge/Node.js%2022.17.1-43853D?logo=node.js&logoColor=white 'Node.js')](https://nodejs.org)
- [![pnpm](https://img.shields.io/badge/pnpm_10.13.1-F69220?logo=pnpm&logoColor=white 'pnpm')](https://pnpm.io)

## Tech Stack

- [![Astro](https://img.shields.io/badge/Astro_5.12.0-000000?logo=astro&logoColor=white 'Astro')](https://astro.build)
- [![TypeScript](https://img.shields.io/badge/TypeScript_5.8.3-3178C6?logo=typescript&logoColor=white 'TypeScript')](https://www.typescriptlang.org)

## Installation

To get started using this app in your localhost, simply paste this command into your terminal:

```bash
git clone https://github.com/ngodingbang/learning-astro
pnpm install
```

## Commands

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

| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm lint` | Lints your code with ESLint |
| `pnpm format` | Formats your code with Prettier |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro -- --help` | Get help using the Astro CLI |

## Author

- NgodingBang - [@ngodingbang](https://github.com/ngodingbang)

## Changelog

You can read the changelog [here](CHANGELOG.md).

## License

You can read the license [here](LICENSE.md).