https://github.com/aeberdinelli/santex
Code Challenge for Santex
https://github.com/aeberdinelli/santex
Last synced: 8 days ago
JSON representation
Code Challenge for Santex
- Host: GitHub
- URL: https://github.com/aeberdinelli/santex
- Owner: aeberdinelli
- Created: 2022-08-22T20:26:48.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-23T17:04:47.000Z (almost 4 years ago)
- Last Synced: 2025-04-10T18:06:35.299Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.97 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Santex Code Challenge
Welcome to my Code Challenge for Santex. I've built this using AWS CDK, AppSync, DynamoDB and TS. I recommend using yarn for running the project because is faster.
### Requirements
You need the following pre requirements:
- NodeJS
- yarn (`npm install -g yarn` - you can use npm if you prefer)
- AWS CLI
### Setup
Rename the `.env.example` file to `.env` and update the values with your desired settings. Keep in mind that a key for the Football Data API is required.
## Deploy
To deploy, use following steps:
- `cd src && yarn` to install lambda dependencies
- `yarn run build` to build TS
- `cdk bootstrap` to deploy CDK dependencies
- `yarn run deploy` to deploy
You should see something like this in your terminal:
```bash
Outputs:
SantexStack.GraphQLAPIKey = ******
SantexStack.GraphQLAPIURL = https://hxf2ycqgkbf5vli6ufgk5dx63q.appsync-api.us-east-1.amazonaws.com/graphql
SantexStack.StackRegion = us-east-1
```
Use that API Key to test the GraphQL API.
## Test it out
You can go into the AWS AppSync console to run some queries more easily (**see examples below**), or you can use any other tool you are familiar with, maybe curl?.
