SGF Meetup API

The SGF Meetup API lists Meetup event details for local tech groups in the Springfield, MO area.

Table of Contents

• How to Use This API
  • Requesting an API Key
  • Authentication
• For Contributors
  • Prerequisites
  • First Time Setup
  • Running the Project
  • Shutting Down
  • Troubleshooting

How to Use This API

Requesting an API Key

Request an API key by opening a GitHub Issue in the SGF Meetup API repo.

In the GitHub Issue, submit a username for the API and contact information. We will assign a password to the username and send it to the contact information listed.

Authentication

For Contributors

Prerequisites

• Node 18.x (Ideally using nvm)
• Docker Desktop
• AWS CLI
• AWS SAM CLI
• An Open SGF AWS Account
  • Message a project organizer to get one set up

First Time Setup

# to the AWS CLI

• aws configure sso
  • SSO session name: <your name>-opensgf
  • SSO start URL: https://opensgf.awsapps.com/start
  • SSO region: us-east-2
  • SSO registration scopes: use the default (push enter)
• Open the link in a browser
  • Verify/enter the code from the terminal
  • Allow access
• Continue configuration in the terminal
  • CLI default client Region: us-east-2
  • CLI default output format: use the default (push enter)
  • CLI profile name: <your name>-opensgf

Set Default AWS Profile (Optional)

Without this you'll need to manually specify your profile for any aws commands. Including the commands in npm scripts.

• Set the AWS_DEFAULT_PROFILE environment variable to the profile name you just created
  • export AWS_DEFAULT_PROFILE=<your name>-opensgf
• Don't forget to reload your shell after setting this!

Install dependencies

nvm install # if using nvm
npm install

Create .env

cp lambdas/.env.example lambdas/.env

Setup initial database

• docker compose up -d
  • If you are on linux or WSL there will likely be permission issues with a folder used by docker
  • You can fix those with sudo chown -R 1000:1000 docker/dynamodb
• npm run dev:sync-dynamodb

Running the project

• docker compose up -d (if not already running)
• nvm use (if using nvm)
• Run importer script
  • npm run dev:importer
• Run API
  • npm run dev:api

Shutting down

• docker compose down

Troubleshooting

SSOTokenProviderFailure When Starting Project

If it's been awhile since you've last run the project, your SSO session in the AWS CLI has expired. To fix it:

• aws sso login
• Open the link in a browser and follow the prompts

npm run dev:sync-dynamodb Hangs in Linux Environments (Including WSL)

This can be caused by permissions errors with the ./docker folder that docker compose creates. To fix it change the permissions of that folder to your local user

sudo chown $USER ./docker -R

npm run dev:sync-dynamodb Causes "UnrecognizedClientException: The security token included in the request is invalid."

Specify a DYNAMODB_ENDPOINT environment variable pointing to localhost.

Example: DYNAMODB_ENDPOINT=http://localhost:8000 npm run dev:sync-dynamodb