Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: note dashboard, add development notes #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fake SES


# Fake SES

Inspired by [Fake DynamoDB] [fake_dynamo] and [Fake SQS] [fake_sqs]


Inspired by [Fake DynamoDB][fake_dynamo] and [Fake SQS][fake_sqs]

## Running

Expand All @@ -12,6 +12,10 @@ $ docker run -it -p 8567:8567 paulakimenko/fake_ses

Set endpoint in your AWS client config to this service.

You can access the dashboard at `http://localhost:8567/dashboard`.

There are also API endpoints:

- to see all messages
```
GET /api/messages
Expand All @@ -28,7 +32,9 @@ DELETE /api/messages

## Development

TODO
Requires Java 8.

Run `mvn clean package docker:build` to build the docker image.

[fake_dynamo]: https://github.com/ananthakumaran/fake_dynamo
[fake_dynamo]: https://github.com/ananthakumaran/fake_dynamo
[fake_sqs]: https://github.com/iain/fake_sqs