Skip to content

simplymequeeny/dynamodb-client-web-gui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status codecov Dependency Status

dynamodb-client-web-gui

A simple web client to view documents from AWS DynamoDB or DynamoDB Local

Getting Started

These instructions will help you how to make the dynamodb-client-web-gui web application running.

Prerequisites

Running the dynamodb-client-web-gui Web Application

1.) Download the latest release executable jar.

  • Using DynamoDB Local Your Dynamodb Local must be up and running
java -jar dynamodb-client-web-gui-1.0.0.jar --endpoint.url=[your dynamodb local endpoint] 
  • Using AWS DynamoDB Before running the dynamodb-client-web-gui web application make sure that your AWS credentials file is in place.
java -jar dynamodb-client-web-gui-1.0.0.jar [--profile=<aws profile>] 

2.) Open up a browser then go to http://localhost:9100

Wait for the web server to start up before connecting

3.) Check Wiki on how to use it

TODO

  • Creating records
  • Updating records
  • Deleting records
  • Importing data from AWS DynamoDB]

Built With

Contributing

If you would like to contribute please see the instructions below.

Setup

  • Download the DynamoDB Local jar or create an account in AWS to create tables in DymamoDB (Please visit AWS for more info)
  • Install JDK 8
  • Install Maven 3+ (I'm using v3.3.9)
  • Get your favorite Java IDE (I'm using IntelliJ Community Edition)
  • Forked this repository
  • Create a branch for your changes

Coding Guidelines

  • Make sure that your changes has a corresponding test/s. Can be in a separate test file or modify the existing file
  • No need for comments as long as the codes are readable

Testing

Start the web application
  • if using AWS DynamoDB, make sure that your AWS credentials is in place. The command line argument profile is optional.
mvn clean spring-boot:run [-Drun.arguments="---profile=<profile>"] 
  • if using DynamoDB Local, start your DynamoDB server first
mvn clean spring-boot:run -Drun.arguments="--endpoint.url=<your dynamodb url>" 
Open up a browser and navigate to http://localhost:9100
Execute all tests with code coverage
mvn cobertura:cobertura 

Submitting Your Changes

  • Please make sure you run all the tests
  • Push your branch in Github
  • Make a pull request. In pull request please do not forget to add comment regarding the changes you want to submit.
  • Monitor the pull request to make sure the Travis build succeeds. If it fails simply make the necessary changes to your branch and push it. Travis will re-test the changes.

Thanks!

Author

See also the list of contributors who participated in this project.

Motivation

I started this web application because I use DynamoDBLocal during the development and testing stages of the ReST WS project that I am involved with.

License

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

Acknowledgments

About

A simple web client to view documents from AWS DynamoDB or DynamoDB Local

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published