README.md 2.58 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
[Cozy][cozy] <YOUR SUPER NEW KONNECTOR NAME>
=======================================

What's Cozy?
------------

![Cozy Logo](https://cdn.rawgit.com/cozy/cozy-guidelines/master/templates/cozy_logo_small.svg)

[Cozy] is a personal data platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you.

What is this konnector about ?
------------------------------

Schoumi's avatar
Schoumi committed
14
This konnector retrieves your declarations from [Net-Entreprises](https://net-entreprises.fr) for Micro/Auto Entrepreneur
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
<YOUR DESCRIPTION HERE>

### Open a Pull-Request

If you want to work on this konnector and submit code modifications, feel free to open pull-requests!
</br>See :
* the [contributing guide][contribute] for more information about how to properly open pull-requests.
* the [konnectors development guide](https://docs.cozy.io/en/dev/konnector/)

### Run and test

Create a `konnector-dev-config.json` file at the root with your test credentials :

```javascript
{
  "COZY_URL": "http://cozy.tools:8080",
Schoumi's avatar
Schoumi committed
31 32 33 34 35
  "fields": {
    "siret":"12345678901234",
    "lastname":"LastName",
    "firstname":"FirstName",
    "password":"1234567890"
Schoumi's avatar
Schoumi committed
36
  }
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
}
```
Then :

```sh
yarn
yarn standalone
```
For running the konnector connected to a Cozy server and more details see [konnectors documentation](https://docs.cozy.io/en/dev/konnector/)

### Cozy-konnector-libs

This connector uses [cozy-konnector-libs](https://github.com/cozy/cozy-konnector-libs). It brings a bunch of helpers to interact with the Cozy server and to fetch data from an online service.

### Maintainer

Schoumi's avatar
Schoumi committed
53
The lead maintainers for this konnector is Schoumi
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69


### Get in touch

You can reach the Cozy Community by:

- [konnectors documentation](https://docs.cozy.io/en/dev/konnector/)
- Chatting with us on IRC [#cozycloud on Freenode][freenode]
- Posting on our [Forum]
- Posting issues on the [Github repos][github]
- Say Hi! on [Twitter]


License
-------

Schoumi's avatar
Schoumi committed
70
Net-Entreprises-AE is developed by Schoumi and distributed under the [AGPL v3 license][agpl-3.0].
71 72 73 74 75 76 77 78 79 80 81 82 83

[cozy]: https://cozy.io "Cozy Cloud"
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html
[freenode]: http://webchat.freenode.net/?randomnick=1&channels=%23cozycloud&uio=d4
[forum]: https://forum.cozy.io/
[github]: https://github.com/cozy/
[nodejs]: https://nodejs.org/
[standard]: https://standardjs.com
[twitter]: https://twitter.com/mycozycloud
[webpack]: https://webpack.js.org
[yarn]: https://yarnpkg.com
[travis]: https://travis-ci.org
[contribute]: CONTRIBUTING.md