Cloud based ActionItems App

A simple web server. Deployed on AWS. The Hard Way

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Describe the project and future improvements and tech used

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Some blurb about running the script to deploy an instance of this app on your own aws

Prerequisites

• AWS Account - run 'aws configure' after installing the cli
• TODO-add more details about setting up aws account/permissions....

You will need the below tools installed and configured

• docker

  brew install docker

• kubectl

  brew install kubectl

• eksctl

  brew install eksctl

• AWS cli - https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

  curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"
  sudo installer -pkg AWSCLIV2.pkg -target /

Installation

• The project is built to simply clone the repo and run the deployment script

1. Clone this repo

2. Have the above command line tools installed and configured

3. sh deploy.sh

4. Get the load balancer url

   kubectl get svc -o wide

5. Visit the url

   http://loadbalancer:8080/items

6. Visit the swagger docs

   http://loadbalancer:8080/swagger-ui/index.html#/

(back to top)

Usage

You now have a todo list server running in aws - get, post, delete. do with it what you will

(back to top)

Roadmap

• Add support for multiple users
• Ensure and document security
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the Apache License. See LICENSE.txt for more information.

(back to top)