Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add Readme and associated files + few npm scripts
  • Loading branch information
Janaka-Steph committed Oct 2, 2017
1 parent a624ed5 commit 385da37
Show file tree
Hide file tree
Showing 7 changed files with 394 additions and 247 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,38 @@
# How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.

If you haven't already, come find us in Slack ([Dether Slack](https://dether.slack.com). We want you working on things you're excited about.

Here are some important resources:

* [Dether Slack](https://dether.slack.com). We're usually there during business hours.
* [SubReddit](https://www.reddit.com/r/Dether/)
* [Telegram](http://t.me/Dether_io)
* [Medium blog](https://medium.com/@DETHER) is where we explain our project and do announcements
* [Twitter](https://twitter.com/dether_io) to follow us
* [Facebook](https://www.facebook.com/dether.io/) to follow us
* Mailing list: Join our [mailing list](https://dether.us16.list-manage.com/subscribe/post?u=dd727296ebfd8ba845b23f156&id=f11fdb74cb)
* Non critical Bug? [Github issue](https://github.com/dethertech/dethercontracts/issues) is where to report them
* Critical Bug? [Private email](bug@dether.io) is where to report them

## Testing

We are testing the smart contracts with Javascript in async/await style, and the Truffle framework to run them. Please write test examples for new code you create.

## Submitting changes

Please send a [GitHub Pull Request to Dether](https://github.com/dethertech/dethercontracts/pulls) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). When you send a pull request, we will love you forever if you include tests. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

## Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

* We indent using two spaces (soft tabs)
* We use async/await for tests
37 changes: 37 additions & 0 deletions ISSUE_TEMPLATE.md
@@ -0,0 +1,37 @@
<!--
Have you read Dether's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/dethertech/dethercontracts/blob/master/CONTRIBUTING.md
Do you want to ask a question? Are you looking for support? The Dether slack is the best place for getting support: https://dether.slack.com
-->

### Prerequisites

* [ ] Put an X between the brackets on this line if you have done all of the following:
* Checked with the Dether team on Slack
* Checked that your issue isn't already filed

### Description

[Description of the issue]

### Steps to Reproduce

1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior:** [What you expect to happen]

**Actual behavior:** [What actually happens]

**Reproduces how often:** [What percentage of the time does it reproduce?]

### Versions

Specify the version of the software and any relevant dependencies.

### Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.
21 changes: 21 additions & 0 deletions LICENCE.md
@@ -0,0 +1,21 @@
The MIT License

Copyright (c) 2017 Dether. https://dether.io

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
28 changes: 28 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,28 @@
### Requirements

* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
* All new code requires tests to ensure against regressions

### Description of the Change

<!--
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
-->

### Alternate Designs

<!-- Explain what other alternates were considered and why the proposed version was selected -->

### Benefits

<!-- What benefits will be realized by the code change? -->

### Possible Drawbacks

<!-- What are the possible side-effects or negative impacts of the code change? -->

### Applicable Issues

<!-- Enter any applicable Issues here -->
86 changes: 85 additions & 1 deletion README.md
@@ -1 +1,85 @@
# Dether contracts
# Dether - Ethereum smart contracts

Dether provides a decentralized peer-to-peer ether network that enables anyone on Earth to buy ether
with cash and spend it at physical stores nearby. No bank account is needed, just a mobile phone with
internet access. Our belief is that the beauty and power of the Ethereum technology should be easily
accessible to all.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

* Node.js 8

* Solc ^0.4.16

If Truffle is shipped with an older version, then update it manually
```
cd node_modules/truffle
// update solc version in package.json
npm upgrade
// side note: `truffle version` will not give you the right version, but it's ok
```

### Installing

Install all the dependencies
```
npm install
```

## Running the tests

Tests on local machine
```
npm run test
```

Tests on Kovan Infura
```
npm run testKovanInfura
```

## Deployment

Migrate on local machine
```
npm run migrate
```

Migrate on Kovan Infura
```
npm run migrateKovanInfura
```

## Built With

* [Truffle](http://truffleframework.com) - Development framework for Ethereum
* [Truffle-lightwallet-provider](https://github.com/DigixGlobal/truffle-lightwallet-provider) - RPC Provider using Eth-Lightwallet & Web3-Provider-Engine
* [Sigmate](https://github.com/DigixGlobal/sigmate) - An Ethereum keystore creation tool
* [Web3](https://github.com/ethereum/web3.js/) - Ethereum JavaScript API
* [Open Zeppelin](https://openzeppelin.org/) - Framework to build secure smart contracts on Ethereum

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dethertech/dethercontracts/tags).

## Authors

* **Mehdi Amari** - [Fukunaga42](https://github.com/Fukunaga42)
* **Stéphane Roche** - [Janaka-Steph](https://github.com/Janaka-Steph)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

We took our inspiration from many Ethereum projects, especially the work done by Digix (Sigmate, Truffle-light-wallet, the ICS pattern) and Open Zeppelin.
Big thanks to all of you contributing to the ecosystem.

0 comments on commit 385da37

Please sign in to comment.