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 simple makefile and update readme #142

Merged
merged 1 commit into from
Feb 12, 2018
Merged

Add simple makefile and update readme #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.PHONY: build start

build:
pipenv install --dev

start:
pipenv run python run.py
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ras-secure-message
[![Build Status](https://travis-ci.org/ONSdigital/ras-secure-message.svg?branch=master)](https://travis-ci.org/ONSdigital/ras-secure-message)
[![Build Status](https://travis-ci.org/ONSdigital/ras-secure-message.svg?branch=master)](https://travis-ci.org/ONSdigital/ras-secure-message)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/4e427a826650454d98ed74dade65a4ff)](https://www.codacy.com/app/ONSDigital/ras-secure-message)
[![codecov](https://codecov.io/gh/ONSdigital/ras-secure-message/branch/master/graph/badge.svg)](https://codecov.io/gh/ONSdigital/ras-secure-message)

Expand All @@ -23,6 +23,11 @@ Use pipenv to create a virtualenv and install dependencies
pipenv install
```

Alternatively you can use make
```bash
make build
```

Set environmental variables. Replace $SOURCE_ROOT with the parent directory of the project.

```
Expand All @@ -43,6 +48,10 @@ or
```bash
docker-compose up
```
or (when postgres is set up)
```bash
make start
```


Test the application
Expand Down Expand Up @@ -99,4 +108,4 @@ The services these variables exist for are listed below with the beginnings of t
| Service | Start of variables | Github
|---------------------------------|-----------------------------|-----------------------------
| Case service | RM_CASE_SERVICE | https://github.com/ONSdigital/rm-case-service
| Party service | RAS_PARTY_SERVICE | https://github.com/ONSdigital/ras-party
| Party service | RAS_PARTY_SERVICE | https://github.com/ONSdigital/ras-party