You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Jolocom SmartWallet - An application to manage your digital identity.
2
+
3
+
Interested in our vision? Take a look at our [whitepaper](https://jolocom.io/wp-content/uploads/2019/12/Jolocom-Whitepaper-v2.1-A-Decentralized-Open-Source-Solution-for-Digital-Identity-and-Access-Management.pdf).
- Set-up requires [Node.js](https://nodejs.org/en/download/) to be installed on your computer.
10
+
- The Jolocom SmartWallet requires `Node.js v12+` to build the project. You can either manually install Node version above 12, or you can delegate it to `Volta` (follow [this link](https://docs.volta.sh/guide/getting-started) to install `Volta`). Node `12.4.1` is pinned to the project
11
+
- We use [Yarn](https://yarnpkg.com) as our package manager.
12
+
- We use [CocoaPods](https://cocoapods.org/) for `iOS` dependency management.
13
+
14
+
## Installation
15
+
16
+
1. Clone the repository to a directory of your choice.
17
+
2.`cd` into the cloned repo and run `yarn` from your terminal to install the required depencencies .
18
+
19
+
### Running a debug version for development
20
+
21
+
#### Android
22
+
23
+
3. Please set up an Android development environment and install the required SDKs.
24
+
- The [Getting Started](https://facebook.github.io/react-native/docs/getting-started) guide for React Native may come in handy.
25
+
- Look for the instructions under React Native CLI Quickstart.
26
+
4. Connect an Android device and enable USB debugging **OR** start an Android AVD emulator
27
+
5. Run `yarn android` to install the application and run it.
28
+
- NOTE: this will start a metro bundler server automatically, with stdout/stderr discarded. You can close this and run `yarn start` to manually start the bundler and receive more detailed output.
29
+
30
+
### iOS
31
+
32
+
3. Please set up an appropriate Xcode development environment.
33
+
- The [Getting Started](https://facebook.github.io/react-native/docs/getting-started) guide for React Native may come in handy.
34
+
- Look for the instructions under React Native CLI Quickstart.
35
+
4.`cd` into the `ios` folder, and install the native dependencies using the `pod install` command.
36
+
5. Run `yarn ios` to install and run the application in an emulator.
37
+
- This will default to an iPhone X emulator.
38
+
- The device can be specified by adding `--simulator` and the device name.
39
+
- e.g. `yarn ios --simulator "iPhone SE"`
40
+
-`NOTE`: this will start a metro bundler server automatically, with stdout/stderr discarded. You can close this and run `yarn start` to manually start the bundler and receive more detailed output.
41
+
-`NOTE`: A debug build can also be built through Xcode.
42
+
43
+
Running a build on a physical device requires the appropriate code signing certificates.
44
+
45
+
## Testing
46
+
We use Jest + [React Native Testing Library](https://testing-library.com/docs/react-native-testing-library/intro/) for unit testing.
47
+
48
+
To run unit tests with watch and testing coverage:
49
+
```bash
50
+
yarn test --watch --coverage
51
+
```
52
+
## Code Style and Formatting
53
+
54
+
- We use [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to keep a consistent style across the codebase.
55
+
- There are plugins available for a range of IDEs and text editors; automatic formatting on save is also supported in some editors.
56
+
- Check the `yarn lint:fix` and `yarn prettier:format` scripts.
0 commit comments