Skip to content

Commit 66f43a2

Browse files
committed
Including some new instructions in README file
1 parent 41bca85 commit 66f43a2

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,26 @@
44

55
> API for ZSSN (Zombie Survival Social Network)
66
7+
## Setup choices
8+
9+
I dockerized this API because i don't know nothing about evaluator machine, so i recommend user docker.
10+
I used some gems like interactor and shoulda-matchers to target best practices in development like `skinny controller and fatty models`. I did all asked features in gist and write tests to cover all source code, you can see coverage executing tests (see section bellow) and open `index.html` in coverage directory.
11+
712
## Dependencies
813

914
First, you need to got `Docker` and `docker-compose` installed on your machine to run this project. Access [here](https://docs.docker.com/compose/install/#install-compose) to get instructions of how install theses dependencies.
1015

16+
But if you prefer use your local database, all you have to do is change include adpater gem of your preference in Gemfile, and change `database.yml` file.
17+
18+
```sh
19+
default: &default
20+
adapter: postgresql # <-- your adapter here
21+
encoding: unicode
22+
host: db # <-- normally localhost
23+
username: postgres # <-- username
24+
password: # <-- password
25+
```
26+
1127
## Install
1228

1329
After properly install `docker-compose`, you can use the command bellow to build:
@@ -27,6 +43,16 @@ docker-compose run survivors-api rails db:drop db:create db:migrate db:seed
2743
docker-compose up
2844
```
2945

46+
## Tests
47+
48+
```sh
49+
docker-compose run survivors-api rspec
50+
```
51+
52+
## Access API documentation
53+
54+
`localhost:3000/apipie`
55+
3056
## Author
3157

3258
- Github: [@andreealencar](https://github.com/andreealencar)

0 commit comments

Comments
 (0)