Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hawapi/website
Main website for HawAPI
https://github.com/hawapi/website
astro astro-build astro-website haw-api hawapi theproject-id
Last synced: 12 days ago
JSON representation
Main website for HawAPI
- Host: GitHub
- URL: https://github.com/hawapi/website
- Owner: HawAPI
- License: mit
- Created: 2022-12-24T00:16:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T20:15:55.000Z (about 1 year ago)
- Last Synced: 2024-11-03T07:40:44.653Z (12 days ago)
- Topics: astro, astro-build, astro-website, haw-api, hawapi, theproject-id
- Language: CSS
- Homepage: https://hawapi.theproject.id
- Size: 612 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# HawAPI - Website
This repository contains the source code required to build the [HawAPI](https://hawapi.theproject.id) website.
## Topics
- [Prerequisites](#prerequisites)
- [Setup](#usage)
- [Scripts](#scripts)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
- Text editor or IDE (VsCode, Subline, Noteped++)
- Yarn
- [Astro](https://astro.build/) for [website](https://github.com/HawAPI/website) generation
## Setup
Step by step of how to run the application.
> See all [Prerequisites](#prerequisites)
### Clone
> **Note** \
> Alternatively, you could [download all files (Zip)](https://github.com/HawAPI/website/archive/refs/heads/main.zip)
- SSH
```
git clone [email protected]:HawAPI/website.git
```
- HTTPS
```
git clone https://github.com/HawAPI/website.git
```
### Application
```
yarn dev
```
Open the browser and go to:
```
http://localhost:4321
```
## Scripts
All scripts are run from the root of the project, from a terminal:
| Command | Action |
| :----------- | :------------------------------------------ |
| `yarn` | Installs dependencies |
| `yarn dev` | Starts local dev server at `localhost:4321` |
| `yarn build` | Build production site to `./build/` |
| `yarn clean` | Remove `./build/` |
## Contributing
You could help continuing its development by:
- [Contribute](CONTRIBUTING.md) to the source code
- Suggest new features and report issues
## Contact
For any questions about the project: [Contact](https://github.com/HawAPI/HawAPI#contact).
## Code of conduct
We will behave ourselves if you behave yourselves. For more details see our
[Code of conduct](https://github.com/HawAPI/HawAPI/blob/main/CODE_OF_CONDUCT.md).
## License
HawAPI is licensed under the [MIT License](LICENSE).
> Check out all [licenses/dependencies](https://hawapi.theproject.id/docs/about/#licenses)