Skip to content

Commit

Permalink
Add configuration for heroku deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
vyahello committed Sep 19, 2019
1 parent e8b0609 commit 7a243d8
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: python mock_parser_api.py
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Fake employees mock data parser API
A lightweight fake mock data API written in [_responder_](http://python-responder.org/en/latest/) python HTTP service framework.
This application will parse fake (mock) employees JSON data and build an API to work with it.
Please follow [mock parser api](https://fake-employee-api.herokuapp.com) app to see how it looks like.

[![Build Status](https://travis-ci.org/vyahello/fake-employee-api.svg?branch=master)](https://travis-ci.org/vyahello/fake-employee-api)
[![Coverage Status](https://coveralls.io/repos/github/vyahello/fake-employee-api/badge.svg?branch=master)](https://coveralls.io/github/vyahello/fake-employee-api?branch=master)
Expand All @@ -9,6 +10,7 @@ This application will parse fake (mock) employees JSON data and build an API to
- [Run application](#run-application)
- [Demo](#demo)
- [Run static code analysis](#run-static-code-analysis)
- [Heroku deployment](#heroku-deployment)
- [Contributing](#contributing)

# Run application
Expand All @@ -27,6 +29,28 @@ To be able to start static code analysis _locally_ please run following script f
./run-code-analysis.sh install-dependencies
```

# Heroku deployment
Please follow instructions from - https://python-responder.org/en/latest/deployment.html

- Install heroku following by - https://devcenter.heroku.com/articles/heroku-cli#download-and-install
- Login to heroku
```bash
heroku login
```
- Create an application
```bash
heroku create fake-employee-api
```
- Commit and push repo into a heroku
```bash
git add . && git commit -m "My first heroku app" && git push heroku master
```
- Check heroku logs
```bash
heroku logs --tail
```
- Open an application via browser: https://fake-employee-api.herokuapp.com

# Contributing
- clone the repository
- configure Git for the first time after cloning with your name and email
Expand Down
1 change: 1 addition & 0 deletions runtime.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python-3.7.4

0 comments on commit 7a243d8

Please sign in to comment.