HawAPI - API-Data

Static data from the HawAPI project.

Topics

• Prerequisites
• Dependencies
• Contributing
• Requesting
  • Requesting#Static
  • Requesting#Translation
• Running
• Contact
• License

Prerequisites

• The HawAPI project running (and all its prerequisites)
• Node
  • Npm or Yarn for run the script

Dependencies

• dotenv

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

Running

Check Requesting

Before running the script:

• Create and define all required variables inside the .env. Use .env.example as reference.

If you are running using local HawAPI application create and define all required variables inside the .env.dev and use the dev command. Use .env.dev.example as reference.

Dev/Test

Using dev command all outputs will be stored on a /dev/ folder.

yarn dev

Production

Using start command all outputs will be stored on a /database/ folder.

yarn start

Contact

For any questions about the project: Contact.

License

HawAPI is licensed under the MIT License.

Check out all licenses/dependencies