Skip to content

API for the learner-gamification application created for TAMU Datathon

License

Notifications You must be signed in to change notification settings

tamu-datathon-org/cosmos-api

Repository files navigation

Cosmos 🌌

General Information ℹ️

  • This is meant to be hosted on AWS, using services like Lambda, DynamoDB and more
  • The project uses serverless to make development and testing using AWS easier, because it could be a pain otherwise.
    • Check out docs/serverless-readme.md for more information
  • The docs/ directory has information for the endpoints served by the API
    • Look at serverless.yml and the various lambdas/*-handlers.yml for more information on these

Getting Started 🏃

  • Get access to your AWS IAM User Access ID & Access Key
  • Install the Serverless framework using npm i -g serverless
  • Install the AWS CLI using pip install awscli
  • Configure your AWS credentials for Serverless to use using aws configure
    • You'll be asked for your Access ID, Access Key and the preferred location
  • You now have access to various Serverless functions
    • Use serverless invoke local --function <function> to locally run a lambda function
    • Use serverless offline start to run the Gateway & lambda functions locally
    • Use serverless deploy to deploy a new build

About

API for the learner-gamification application created for TAMU Datathon

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published