Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 2.07 KB

README.md

File metadata and controls

58 lines (35 loc) · 2.07 KB

The Stemplayer-JS Backend API

A nested AWS SAM / Cloudformation stack of certain serverless microservices to provide the stemplayer with

Architecture

Usage

You can either deploy from by checking out this repository and following the steps below; but absolutely the easiest way is to deploy it directly from the AWS Serverless Application Repository into your own AWS account.

Prerequisites

  • Make sure you have installed AWS SAM CLI
  • Create a SAM deployment bucket
  • Copy cp .env.dist .env and fill out the required variables

Installation

Run npm install

Or yarn install

Deployment

Run make deploy

Test

Run make test

Destroy

To destroy the stack and remove all resources run make destroy.

Production

Make sure that the values for CORS_ALLOWED_ORIGINS and ALLOWED_AUDIO_ORIGINS (in .env) are set to non wildcard values

License

Copyright (C) 2019-2024 First Coders LTD

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.