unfor19/aws-webui repository overview

⁠aws-webui

A Single Page Application to manage AWS resources efficiently.

This application was built with:

• TypeScript⁠
• Vue v3⁠
• Quasar v2⁠
• AWS SDK for JavaScript v3⁠

⁠Requirements

• Node⁠ 14.x+
• yarn⁠ 1.22+
• quasar CLI⁠ v3.x
• Docker⁠ and Docker-Compose⁠ for testing locally with localstack⁠
• (Optional) AWS CLI⁠ - for modifying values via terminal

⁠Getting Started

⁠Quick Start

1. Download relevant files

   curl -sL -o docker-compose.yml "https://raw.githubusercontent.com/unfor19/aws-webui/master/docker-compose.yml"
   

   Copy
2. Run the application (GUI) and localstack⁠ - a backend server that immitates AWS SSM Parameters API⁠

   docker-compose -p awswebui --profile frontend up --detach
   

   Copy
3. View the application in a browser - http://localhost:8081⁠
4. Cleanup

   docker-compose -p awswebui down && \
   rm docker-compose.yml
   

   Copy

⁠Run From Source Code

1. Fork/Clone this repo
2. Install application's dependencies

   yarn install
   

   Copy
3. Build the application

   yarn build
   

   Copy
4. Install server's (Express JS⁠) dependencies

   yarn --cwd server run install-dependencies
   

   Copy
5. Start localstack⁠

   yarn localstack:up
   

   Copy
6. Run the application in production mode

   yarn serve:prod
   

   Copy
7. View the application in a browser - http://localhost:8080⁠

⁠Docker

⁠Run Official Container

1. Run the application in Docker

   docker run --rm -it -p 8080:8080 unfor19/aws-webui
   

   Copy
2. View the application in a browser - http://localhost:8080⁠

⁠Build Docker Image From Source Code

1. Fork/Clone this repo
2. Build the application

   docker build -t aws-webui .
   

   Copy
3. Run the application in production mode

   docker run --rm -it -p 8080:8080 aws-webui
   

   Copy
4. View the application in a browser - http://localhost:8080⁠

⁠Contributing

Report issues/questions/feature requests on the Issues⁠ section.

Pull requests are welcome! These are the steps:

1. Fork this repo
2. Install application's dependencies

   yarn install
   

   Copy
3. Create your feature branch from master (git checkout -b my-new-feature)
4. Start localstack⁠

   yarn localstack:up
   

   Copy
5. Start development server - will automatically open a new browser with hot-reload

   yarn serve
   

   Copy
6. Add the code of your new feature
7. Commit your remarkable changes (git commit -am 'Added new feature')
8. Push to the branch (git push --set-up-stream origin my-new-feature)
9. Create a new Pull Request and provide details about your changes

⁠TODO

• (WIP) Add the action bulk edit value with the options to find and replace and add prefix/suffix. Requires a new function editItems(items)
• Add the action - export selected items to a JSON file, the structure per service should be declared in src/router/routes.ts. For SSM the structure as in unfor19/parzival⁠. Requires a new function exportItemsToFile(items)
• Add the action - export selected items to a JSON string, the structure per service should be declared in src/router/routes.ts. For SSM the structure as in unfor19/parzival⁠. Requires a new function exportItemsToString(string)
• Add the action - import items from a JSON file attempts to create/update items, and returns information about which ones were successfully updated and which ones failed. Requires a new function importItemsFromFile(inputFilePath)
• Add the action - import items from a JSON string attempts to create/update items, and returns information about which ones were successfully updated and which ones failed. Requires a new function importItemsFromString(string)

⁠Authors

Created and maintained by Meir Gabay⁠

⁠License

This project is licensed under the Apache License - see the LICENSE⁠ file for details