This wishtree application currently runs within the AWS Platform currently and is in Beta version where improvements and suggestions are welcome.
In order to get the application up and running you will need the following things already setup or available to you:
- An active AWS Account
- The Serverless Framework installed on your machine (This will provide the quickest installation of the application)
If you haven't got the serverless framework installed or configured visit https://serverless.com for instructions for your operating system on how to install and setup for working with AWS.
- Download and Unzip the Wishtree Application found within the GitHub project.
- Copy the api/config.sample.json to
api/config.<stagename>.json - Update the
config.\<stagename>.jsonfile updating config as requiredWISH_TREE_TAGS_TABLE- Name of the DynamoDB table to store the wishtree tagsWISH_TREE_S3_BUCKET- (Optional) If you require an S3 bucket to store the website on, set the name of the bucket here.
- (Optional) If an S3 Bucket needs to be created to store the website, please open the
api/serverless.ymlfile and uncomment the S3 Bucket resource creation section. - Using SLS deploy the application using the command
sls deploy --stage <stagename>
- Once the command finishes you will need to grab the API Endpoint URLs for GET and POST and update the following files:
- Navigate to the website folder in terminal / command line and use this command and this will upload the website files into the s3 bucket.
aws s3 sync . s3://<S3BucketName> --acl public-read
- You can then visit the Public URL for the bucket
If there are any improvements or support queries surrounding the use of this application, feel free to open an Issue and one of the team will look into it. We are also accepting Pull Requests, so if there are any improvements that you would like to make to the application we will be happy to review and put them in!
