README.md

HawAPI - Website

This repository contains the source code required to build the HawAPI website.

Topics

• Prerequisites
• Setup
• Scripts
• Contributing
• License

Prerequisites

• Text editor or IDE (VsCode, Subline, Noteped++)
• Yarn
  • Astro for website generation

Setup

Step by step of how to run the application.

See all Prerequisites

Clone

Note
Alternatively, you could download all files (Zip)

• SSH

git clone git@github.com: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 to the source code
• Suggest new features and report issues

Contact

For any questions about the project: Contact.

Code of conduct

We will behave ourselves if you behave yourselves. For more details see our Code of conduct.

License

HawAPI is licensed under the MIT License.

Check out all licenses/dependencies