Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hawapi/docs
All documentation related with HawAPI
https://github.com/hawapi/docs
api api-docs docs haw-api hawapi stranger-things-api theproject-id
Last synced: about 20 hours ago
JSON representation
All documentation related with HawAPI
- Host: GitHub
- URL: https://github.com/hawapi/docs
- Owner: HawAPI
- License: mit
- Created: 2022-12-20T14:48:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T20:21:35.000Z (about 1 year ago)
- Last Synced: 2023-11-03T15:27:51.017Z (about 1 year ago)
- Topics: api, api-docs, docs, haw-api, hawapi, stranger-things-api, theproject-id
- Language: HTML
- Homepage: https://hawapi.theproject.id/docs/
- Size: 438 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HawAPI - Docs
Docs for the [HawAPI](https://github.com/HawAPI/HawAPI) project.
## Topics
- [Prerequisites](#prerequisites)
- [Dependencies](#dependencies)
- [Running](#running)
- [Contact](#contact)
- [License](#license)
## Prerequisites
- Node
- Yarn for **run the scripts**
## Dependencies
- [retype](https://www.npmjs.com/package/retypeapp)
## 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/docs/archive/refs/heads/main.zip)
- SSH
```
git clone [email protected]:HawAPI/docs.git
```
- HTTPS
```
git clone https://github.com/HawAPI/docs.git
```
### Running
> Check [Requesting](./docs/REQUESTTING.md)
#### Dev/Test
Using **dev** command all outputs will be stored on memory.
```
yarn dev
```
#### Production
Using **build** command all outputs will be stored on a `/build/` folder.
```
yarn build
```
## Contact
For any questions about the project: [Contact](https://github.com/HawAPI/HawAPI#contact).
## License
HawAPI is licensed under the [MIT License](https://github.com/HawAPI/docs/blob/main/LICENSE).
> Check out all [licenses/dependencies](https://hawapi.theproject.id/docs/about/#licenses)