Skip to content

Commit

Permalink
Merge pull request #440 from Bit-Nation/release/0.5.2
Browse files Browse the repository at this point in the history 
Tests and ESLint checked manually.
  • Loading branch information
@seland
seland committed Jul 19, 2018
2 parents 5f01516 + 205d0a7 commit 7bf27ba
Show file tree
Hide file tree
Showing 194 changed files with 16,851 additions and 6,313 deletions.
3 changes: 2 additions & 1 deletion .eslintrc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"no-underscore-dangle": 0,
"react/require-default-props":0,
"max-len": "off",
"import/prefer-default-export": "off"
"import/prefer-default-export": "off",
"class-methods-use-this": "off"
},
"globals": {
"Generator": true
Expand Down
112 changes: 46 additions & 66 deletions Readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,66 +1,46 @@
# Bitnation Pangea Mobile Client

[![Build Status](https://semaphoreci.com/api/v1/florianlenz/bitnation-pangea-mobile/branches/master/badge.svg)](https://semaphoreci.com/florianlenz/bitnation-pangea-mobile)
[![Coverage Status](https://coveralls.io/repos/github/Bit-Nation/BITNATION-Pangea-mobile/badge.svg?branch=master)](https://coveralls.io/github/Bit-Nation/BITNATION-Pangea-mobile?branch=develop)
[Docs](http://bitnation-pangea-mobile.readthedocs.io/)

## Docs
You can find the docs [here](http://bitnation-pangea-mobile.readthedocs.io/)

## Development

### Project setup

1. Clone the repo
2. Run `npm install`
3. Copy `.env.dev.example` to `.env`
4. Set `ETH_HTTP_ENDPOINT` to your ethereum node json rpc endpoint (Mainnet: https://mainnet.infura.io/btn_dev | Ropsten: https://ropsten.infura.io/btn_dev | Rinkeby: https://rinkeby.infura.io/btn_dev)
5. Set `PRODUCTION` to true/false.

#### IOS specific
1. Get [cocoapods](https://cocoapods.org/)
2. Go to the `ios` folder
3. Run `pod install`
4. Go back to the project root and run `npm run ios`

#### Android specific
1. Run `npm run android`

### Git & best practice

- We use [this](http://nvie.com/posts/a-successful-git-branching-model/) branching model. Make sure to read it.
- PLEASE prefix your commit's with a topic like this: `[git] blacklisted .idea`
- Write test's for your code

### Workflow
1. A github issue is created and tagged with "Needs Review". Needs Review mean that the issue need's to be reviewed by a teammeber. E.g. If it's about design by David. If it's about backend by Florian and so on.
2. After the issue is reviewed and ready to get solved remove the "Need's review" label and add the "Reviewed" label. That show's an dev's that the issue is ready to get solved.
3. When you decide to work on an specific reviewed issue assign it your self and start working on it.
4. After you worked on the issue and it's done create a pull request and place a reference to the issue in the pull request body. Make sure that the CI is passing and select someone who reviews the pull request.
5. After you created the pull request you are almost done. The reviewer will ping you if there is a problem with the pull request.

### Tools & Framework's
We are using:
- [Redux](https://github.com/reactjs/react-redux) for state management.
- [Redux-Saga](https://github.com/redux-saga/redux-saga) for handling asynchronous state changes.
- [React Native Navigation](https://github.com/wix/react-native-navigation) for truly native navigation.
- [Lodash](https://lodash.com) for great preset of utility functions on data structures.
- [Jest](https://facebook.github.io/jest/) for unit testing.
- [Enzyme](https://github.com/airbnb/enzyme) for snapshot testing.
- [Detox](https://github.com/wix/detox) for end-to-end testing. Checkout [docs](./docs/detox_usage.md) for more infromation.
- [ESLint](https://eslint.org) for checking code style and quality. Checkout [docs](./docs/eslint_usage.md) for more information.

### Project structure

- `./src/actions` contains actions contants and action creator functions.
- `./src/assets/images` contains all images. It's preferred to keep @2x and @3x files for iOS devices with different scale factor.
- `./src/components` contains all common components.
- `./src/global` contains constans like images, colors and screens.
- `./src/reducers` contains reducers and initial states.
- `./src/sagas` contains sagas (see [Redux-Saga](https://github.com/redux-saga/redux-saga)).
- `./src/screens` contains screen components.
- `./src/services` contains services.
- `./src/utils` contains functions that is useful in different parts of the app.
- `./__tests__` contains all the tests

### [Docs](./docs/main.md)
# pangea

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![Build Status](https://app.bitrise.io/app/be68de279aca4575/status.svg?token=pXZD3QeHe1TRK7YbQ0OnJQ&branch=develop)](https://app.bitrise.io/app/be68de279aca4575)

> Bitnations Blockchain Jurisdiction
TODO: Fill out this long description.

## Table of Contents

- [Security](#security)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)

## Security
If you find a bug / vulnerability please DO NOT open an issue. Write to `security@bitnation.co` PLEASE use [this](security-bitnation.co.key.pub) PGP key to encrypt your report / email.

## Install
> Look at our install section from the [docs](https://bitnation-pangea-mobile.readthedocs.io/)
## Usage

```
```

## API
> If you would like to develop an DApp for Pangea please checkout [this part](https://bitnation-pangea-mobile.readthedocs.io/) of the documentation
## Maintainers

[@seland](https://github.com/seland)

## Contribute

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MIT © 2018 Bitnation
66 changes: 66 additions & 0 deletions Readme.md.old
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Bitnation Pangea Mobile Client

[![Build Status](https://semaphoreci.com/api/v1/florianlenz/bitnation-pangea-mobile/branches/master/badge.svg)](https://semaphoreci.com/florianlenz/bitnation-pangea-mobile)
[![Coverage Status](https://coveralls.io/repos/github/Bit-Nation/BITNATION-Pangea-mobile/badge.svg?branch=master)](https://coveralls.io/github/Bit-Nation/BITNATION-Pangea-mobile?branch=develop)
[Docs](http://bitnation-pangea-mobile.readthedocs.io/)

## Docs
You can find the docs [here](http://bitnation-pangea-mobile.readthedocs.io/)

## Development

### Project setup

1. Clone the repo
2. Run `npm install`
3. Copy `.env.dev.example` to `.env`
4. Set `ETH_HTTP_ENDPOINT` to your ethereum node json rpc endpoint (Mainnet: https://mainnet.infura.io/btn_dev | Ropsten: https://ropsten.infura.io/btn_dev | Rinkeby: https://rinkeby.infura.io/btn_dev)
5. Set `PRODUCTION` to true/false.

#### IOS specific
1. Get [cocoapods](https://cocoapods.org/)
2. Go to the `ios` folder
3. Run `pod install`
4. Go back to the project root and run `npm run ios`

#### Android specific
1. Run `npm run android`

### Git & best practice

- We use [this](http://nvie.com/posts/a-successful-git-branching-model/) branching model. Make sure to read it.
- PLEASE prefix your commit's with a topic like this: `[git] blacklisted .idea`
- Write test's for your code

### Workflow
1. A github issue is created and tagged with "Needs Review". Needs Review mean that the issue need's to be reviewed by a teammeber. E.g. If it's about design by David. If it's about backend by Florian and so on.
2. After the issue is reviewed and ready to get solved remove the "Need's review" label and add the "Reviewed" label. That show's an dev's that the issue is ready to get solved.
3. When you decide to work on an specific reviewed issue assign it your self and start working on it.
4. After you worked on the issue and it's done create a pull request and place a reference to the issue in the pull request body. Make sure that the CI is passing and select someone who reviews the pull request.
5. After you created the pull request you are almost done. The reviewer will ping you if there is a problem with the pull request.

### Tools & Framework's
We are using:
- [Redux](https://github.com/reactjs/react-redux) for state management.
- [Redux-Saga](https://github.com/redux-saga/redux-saga) for handling asynchronous state changes.
- [React Native Navigation](https://github.com/wix/react-native-navigation) for truly native navigation.
- [Lodash](https://lodash.com) for great preset of utility functions on data structures.
- [Jest](https://facebook.github.io/jest/) for unit testing.
- [Enzyme](https://github.com/airbnb/enzyme) for snapshot testing.
- [Detox](https://github.com/wix/detox) for end-to-end testing. Checkout [docs](./docs/detox_usage.md) for more infromation.
- [ESLint](https://eslint.org) for checking code style and quality. Checkout [docs](./docs/eslint_usage.md) for more information.

### Project structure

- `./src/actions` contains actions contants and action creator functions.
- `./src/assets/images` contains all images. It's preferred to keep @2x and @3x files for iOS devices with different scale factor.
- `./src/components` contains all common components.
- `./src/global` contains constans like images, colors and screens.
- `./src/reducers` contains reducers and initial states.
- `./src/sagas` contains sagas (see [Redux-Saga](https://github.com/redux-saga/redux-saga)).
- `./src/screens` contains screen components.
- `./src/services` contains services.
- `./src/utils` contains functions that is useful in different parts of the app.
- `./__tests__` contains all the tests

### [Docs](./docs/main.md)

0 comments on commit 7bf27ba

Please sign in to comment.