zepio/README.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2019-03-27 19:29:01 -07:00
# Zepio | ZEC Wallet
2018-11-23 10:41:50 -08:00
2019-04-16 20:23:02 -07:00
Zepio is a Sapling-enabled shielded-address first Zcash wallet, featuring cross-platform applications (macOS, Windows and Linux), built-in full node with support for `mainnet` and `testnet`, as well as `dark` and `light` themes.
2018-11-23 10:41:50 -08:00
2019-04-10 07:15:33 -07:00
![Flow Coverage](./public/flow-coverage-badge.svg)
2019-04-16 20:23:02 -07:00
### [Latest Documentation at https://zepiowallet.com](https://zepiowallet.com)
> CURRENTLY ONLY A PRE-RELEASE AVAILABLE
2019-04-16 20:23:02 -07:00
2018-11-23 10:41:50 -08:00
## Stack Information
2018-11-23 14:51:43 -08:00
- [Electron](https://github.com/electron/electron): desktop application builder
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
- [React](https://facebook.github.io/react/): UI view layer
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
- [Redux](http://redux.js.org/): predictable state container
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
- [Webpack](http://webpack.github.io/): module bundler
2019-04-10 07:15:33 -07:00
2018-11-23 14:51:43 -08:00
- [Webpack Development Server](https://webpack.github.io/docs/webpack-dev-server.html): development server
2019-04-10 07:15:33 -07:00
2018-11-23 14:51:43 -08:00
- [Babel](http://babeljs.io/): ES7/JSX transpilling
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
- [ESLint](http://eslint.org/): code rules and linting
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
- [React Router](https://github.com/reactjs/react-router): routing solution for react
2019-04-10 07:15:33 -07:00
2018-11-30 08:13:18 -08:00
- [Styled Components](https://www.styled-components.com/): visual primitives for theming applications
2018-11-23 10:41:50 -08:00
## Installation
```bash
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
yarn install
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
```
## Development
2018-11-30 08:13:18 -08:00
To run the application you simply need to run
2018-11-23 10:41:50 -08:00
```bash
2019-04-10 07:15:33 -07:00
2018-11-28 16:55:26 -08:00
yarn start
2019-04-10 07:15:33 -07:00
2018-11-23 10:41:50 -08:00
```
2018-11-30 08:13:18 -08:00
This will kickstart the webpack development server and serve the app on port 8080, as well as launch the Electron wrapper for the application, which houses the `zcashd` daemon process.
2018-11-23 10:41:50 -08:00
## License
2019-03-27 19:29:01 -07:00
MIT © Zcash Foundation 2019