aurora-api

Provide an structured data API on top of NOAA's Aurora Forecast

Deploy with CloudFormation

Prerequisites: Node.js, Yarn, and AWS CLI installed

• Create an AWS Account and IAM User with the AdministratorAccess AWS Managed Policy
• Run aws configure to put store that user's credentials in ~/.aws/credentials
• Create an S3 bucket for storing the Lambda code and store its name in a shell variable with:
  • export CODE_BUCKET=bucket
• Install dependencies via yarn:
  • yarn install
• Build:
  • yarn build
• Upload package to S3, transform the CloudFormation template:
  • yarn package
• Deploy to CloudFormation:
  • yarn deploy

Deploy from the AWS Serverless Application Repository

• Hit "Deploy" from the application page

Use

• Go to API Gateway in the AWS Console to find the invoke URL and open it in your browser.
• Sample Data

{
  "issued": "2018-02-01T00:30:00.000Z",
  "breakdown": [
    {
      "start": "2018-02-01T00:00:00.000Z",
      "kp": "3"
    },
    {
      "start": "2018-02-02T00:00:00.000Z",
      "kp": "2"
    },
    ...
  ]
}

Links

• aurora-api on Github
• aurora-api on the AWS Serverless Application Repository
• NOAA Space Weather Scales
• 3-Day Forecast
• UAF Aurora Forecast

License

© 2018-2023 Evan Chiu. This project is available under the terms of the MIT license.