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.

Sign up for GitHub

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

Add local dev setup details in CONTRIBUTING.MD | Adarsh #27

Merged
merged 3 commits into from
Oct 26, 2019
Merged

Add local dev setup details in CONTRIBUTING.MD | Adarsh #27

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ce91c2
Add local dev setup details in CONTRIBUTING.MD | Adarsh
m4ver1k Oct 26, 2019
e9c9902
Merge branch 'master' into add_local_docs
italolelis Oct 26, 2019
6510ed9
Merge branch 'master' into add_local_docs
italolelis Oct 26, 2019
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
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ Unsure where to begin contributing to Outboxer? You can start by looking through

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

### Local Workspace Setup

For local development use the `docker` containers.

Run `docker-compose up -d` from `build` directory to bring up `rabbitmq` and `localstack`.

RabbitMQ management portal will be available at `http://localhost:15672/`.

A local `Kinesis` setup using `localstack` will be available at `http://localhost:4568`.

### Pull Requests

* Include screenshots and animated GIFs in your pull request whenever possible.
Expand Down