Skip to content

Commit

Permalink
Added simple readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PicoCreator committed Jan 10, 2020
1 parent b616a18 commit 612bce7
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@

Visit [our site](https://inboxkitten.com) to give a spin, or ...

Follow the 5 steps guide below to get started on Firebase!
# Docker Deployment Guide

- [Step 0 - Clone Me](#step-0---clone-me)
- [Step 1 - Mailgun & Firebase signup](#step-1---mailgun--firebase-signup)
- [Step 2 - Configuration](#step-2---configuration)
- [Step 3 - Build the package](#step-3---build-the-package)
- [Step 4 - Deployment](#step-4---deployment)
Its one simple line - after signing up for mailgun, and getting your api key

For other deployment options, refer to the following guide.

- [localhost/custom manual configuration guide](#developing-on-localhost--custom-deployment)
```
# PS: you should modify this for your use case
docker run \
-e MAILGUN_EMAIL_DOMAIN="<email-domain>" \
-e MAILGUN_API_KEY="<api-key>" \
-e WEBSITE_DOMAIN="localhost:8000" \
-p 8000:8000 \
inboxkitten
```

> Also do let us know how we can help make this better 😺
And head over to port 8000 - for your inboxkitten

# Support us on product hunt 🚀

Expand All @@ -36,6 +38,20 @@ For other deployment options, refer to the following guide.

## Step 0 - Clone Me

Follow the 5 steps guide below to get started on Firebase!

- [Step 0 - Clone Me](#step-0---clone-me)
- [Step 1 - Mailgun & Firebase signup](#step-1---mailgun--firebase-signup)
- [Step 2 - Configuration](#step-2---configuration)
- [Step 3 - Build the package](#step-3---build-the-package)
- [Step 4 - Deployment](#step-4---deployment)

For other deployment options, refer to the following guide.

- [localhost/custom manual configuration guide](#developing-on-localhost--custom-deployment)

> Also do let us know how we can help make this better 😺
```
$ git clone https://github.com/uilicious/inboxkitten.git
```
Expand Down

0 comments on commit 612bce7

Please sign in to comment.