life-code/primeira-mao

# Primeira Mão Documentation


## Install:
> Note: We recommend installation via **Composer**. You can also download the repository as a [zip file](https://github.com/life-code/primeira-mao/archive/master.zip) or make a clone via Git. 

 
## Install by Composer:
> To download and install Composer in your environment go to https://getcomposer.org/download/ and if you have questions about how to use it, consult the [official Composer documentation](https://getcomposer.org/doc).

Run the low command on the terminal:
```sh
$ composer require life-code/primeira-mao
```

## Configuration: ##
Create a file named .env at the root of your project (at the same level as the vendor folder). The example below:

```sh
* project-name
    * vendor/
    * .env
```


Within file .env, declare the following variables:

```sh
PRIMEIRA_MAO_ACCESS_KEY=your-access-key
PRIMEIRA_MAO_ACCESS_SECRET=your-access-secret
PRIMEIRA_MAO_LOCATION=pt-br
```

Ready, your Primeira Mão library is ready for use!

- [Profiles](https://github.com/life-code/primeira-mao/tree/master/docs/profiles.md)
- [Resales](https://github.com/life-code/primeira-mao/tree/master/docs/resales.md)
- [Ads](https://github.com/life-code/primeira-mao/tree/master/docs/ads.md)
- [Categories](https://github.com/life-code/primeira-mao/tree/master/docs/categories.md)
- [Newspapers](https://github.com/life-code/primeira-mao/tree/master/docs/newspapers.md)
- [Search 2.0](https://github.com/life-code/primeira-mao/tree/master/docs/search-2.0.md)


## Contribution Guidelines
Contribute to the Primeira Mão and help bring this idea forward!