-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from elixir-waffle/feature/2019-08-28-fix-warnings
add documentation for local development setup
- Loading branch information
Showing
5 changed files
with
50 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
version: "2.4" | ||
services: | ||
waffle: | ||
build: | ||
context: . | ||
dockerfile: Dockerfile.codeship | ||
command: tail -f /dev/null | ||
volumes: | ||
- .:/srv/app:cached |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Development | ||
|
||
Development documentation with instructions how to setup the project for local development. | ||
|
||
## Preliminary | ||
|
||
* Docker | ||
|
||
```sh | ||
# screen 1 | ||
$ docker-compose up | ||
|
||
# screen 2 | ||
$ docker-compose exec waffle sh | ||
$ > mix deps.get | ||
``` | ||
|
||
## Run tests | ||
|
||
### Tests without S3 integration | ||
```sh | ||
$ mix test | ||
``` | ||
|
||
### Tests with S3 integration | ||
|
||
AWS S3 setup | ||
- create a new user with FullS3Access | ||
- copy `key_id` and `secret` | ||
- create a new backet with *public access* | ||
- comment the `s3` exlusion inside `test/test_helper.exs` | ||
|
||
```sh | ||
$ export WAFFLE_TEST_BUCKET= | ||
$ export WAFFLE_TEST_S3_KEY= | ||
$ export WAFFLE_TEST_S3_SECRET= | ||
$ mix test | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters