chore(docs): updating and improving documentation
chore(docz): docz component lib config clean up
This commit is contained in:
Andre Neves
parent
dc85e802e2
commit
a48d6b4427
|
|
@ -1,9 +1,6 @@
|
|||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||
email, or any other method with the owners of this repository before making a change.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue with the owners and core contributors of this repository. Please note we have a [Code of Conduct](https://github.com/ZcashFoundation/zepio/blob/master/CODE_OF_CONDUCT.md) - please follow it in all your interactions with the project.
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
|
|
@ -16,8 +13,8 @@ Please note we have a code of conduct, please follow it in all your interactions
|
|||
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
||||
do not have permission to do that, you may request the second reviewer to merge it for you.
|
||||
|
||||
Learn more about this project's [development workflow](https://github.com/andrerfneves/zepio/blob/master/DEVELOPMENT_WORKFLOW.md).
|
||||
Learn more about this project's [development workflow](https://github.com/ZcashFoundation/zepio/blob/master/DEVELOPMENT_WORKFLOW.md).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
For information on this project's Code of Conduct details, please see [this file](https://github.com/andrerfneves/zepio/blob/master/CODE_OF_CONDUCT.md).
|
||||
For information on this project's Code of Conduct details, please see [this file](https://github.com/ZcashFoundation/zepio/blob/master/CODE_OF_CONDUCT.md).
|
||||
|
|
@ -16,7 +16,7 @@ The following lists the branching semantics to follow:
|
|||
|
||||
## Commit Messages
|
||||
|
||||
Commit messages should have semantic meanings to make it more easily possible to comb through commits. The following are commit types to follow.
|
||||
Commit messages should have semantic meanings, and explain the 'why' of the change performed, to make it more easily possible to comb through commits. The following are commit types to follow.
|
||||
|
||||
* **feature**: New feature
|
||||
* **hotfix**: Bug fixes
|
||||
|
|
@ -45,6 +45,6 @@ docs: commit messages doc
|
|||
|
||||
### Title
|
||||
|
||||
The title of the PR should have the type shown (feature, hotfix, chore, etc..) as well as a brief description of the PR's purpose. Example
|
||||
The title of the PR should have the type shown (feature, hotfix, chore, etc..) as well as a brief description of the PR's purpose. Example:
|
||||
|
||||
`[feature] Add Infinite Scroll`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2019 Zcash Foundation
|
||||
Copyright (c) 2019 Zcash Foundation zfnd.org
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
130
README.md
130
README.md
|
|
@ -1,54 +1,124 @@
|
|||
# Zepio | ZEC Wallet
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### [Latest Documentation at https://zepiowallet.com](https://zepiowallet.com)
|
||||
### [Latest Documentation](https://zepiowallet.com)
|
||||
|
||||
> CURRENTLY ONLY A PRE-RELEASE AVAILABLE
|
||||
### [Latest Release](https://github.com/ZcashFoundation/zepio/releases)
|
||||
|
||||
|
||||
|
||||
## Stack Information
|
||||
|
||||
- [Electron](https://github.com/electron/electron): desktop application builder
|
||||
|
||||
- [React](https://facebook.github.io/react/): UI view layer
|
||||
|
||||
- [Redux](http://redux.js.org/): predictable state container
|
||||
|
||||
- [Webpack](http://webpack.github.io/): module bundler
|
||||
|
||||
- [Webpack Development Server](https://webpack.github.io/docs/webpack-dev-server.html): development server
|
||||
List of the main open source libraries and technologies used in building **Zepio**:
|
||||
|
||||
- [zcashd](https://github.com/zcash/zcash): Zcash node daemon
|
||||
- [Electron](https://github.com/electron/electron): Desktop application builder
|
||||
- [React](https://facebook.github.io/react/): User interface view layer
|
||||
- [Redux](http://redux.js.org/): Predictable application state container
|
||||
- [Styled Components](https://www.styled-components.com/): Visual primitives for theming and styling applications
|
||||
- [webpack](http://webpack.github.io/): Application module bundler (and more)
|
||||
- [Babel](http://babeljs.io/): ES7/JSX transpilling
|
||||
- [ESLint](http://eslint.org/): Code linting rules
|
||||
- [Flow](https://flow.org): JavaScript static type checker
|
||||
- [Docz](https://docz.site): Documentation builder
|
||||
|
||||
- [ESLint](http://eslint.org/): code rules and linting
|
||||
|
||||
- [React Router](https://github.com/reactjs/react-router): routing solution for react
|
||||
|
||||
- [Styled Components](https://www.styled-components.com/): visual primitives for theming applications
|
||||
|
||||
## Installation
|
||||
## Installing and Running From Source
|
||||
|
||||
To run **Zepio** from source you'll need to perform the following steps:
|
||||
```bash
|
||||
# Ensure you have Node LTS v8+
|
||||
# https://nodejs.org/en/
|
||||
|
||||
# Clone Codebase
|
||||
git clone git@github.com:ZcashFoundation/zepio.git
|
||||
|
||||
# Install Dependencies
|
||||
# inside of the `zepio` folder
|
||||
yarn install
|
||||
# or
|
||||
npm install
|
||||
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
To run the application you simply need to run
|
||||
|
||||
```bash
|
||||
|
||||
# Start Application
|
||||
# webpack development server hosts the application on port
|
||||
# 8080 and launches the Electron wrapper, which also hosts
|
||||
# the `zcashd` node daemon process.
|
||||
yarn start
|
||||
|
||||
# or
|
||||
npm start
|
||||
```
|
||||
|
||||
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.
|
||||
## Building Application Locally
|
||||
|
||||
To build the application locally follow the instructions below:
|
||||
```bash
|
||||
# Make sure you are inside of the main `zepio` folder
|
||||
|
||||
# Run Build Script
|
||||
yarn electron:distall
|
||||
|
||||
# Executables and binaries available under `/dist` folder
|
||||
```
|
||||
|
||||
## Flow Coverage
|
||||
|
||||
For a deeper look on the static typing coverage of the application, please follow below:
|
||||
```bash
|
||||
# Make sure you are inside of the main `zepio` folder
|
||||
|
||||
# Generate Flow Coverage Report
|
||||
# this can take a couple seconds
|
||||
yarn flow:report
|
||||
|
||||
# Browser should open with the file `index.html` opened
|
||||
# Files are also available at `zepio/flow-coverage/source`
|
||||
```
|
||||
|
||||
## Component Library (Docz)
|
||||
|
||||
To see Zepio's React component library, please visit https://zepio-components.now.sh. We're always looking for folks to help keep the styleguide updated.
|
||||
|
||||
To run the component library locally, run the following:
|
||||
```bash
|
||||
# Make sure you are inside of the main `zepio` folder
|
||||
|
||||
# Run Docz Development Script
|
||||
yarn docz:dev
|
||||
|
||||
# Visit http://127.0.0.1:4000/
|
||||
```
|
||||
|
||||
To build the component library locally, run the following:
|
||||
```bash
|
||||
# Make sure you are inside of the main `zepio` folder
|
||||
|
||||
# Run Build Script
|
||||
yarn docz:build
|
||||
|
||||
# Check `/.docz/dist` folder for built static assets
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
To run the application's tests, please run the below:
|
||||
```bash
|
||||
# Make sure you are inside of the main `zepio` folder
|
||||
|
||||
# For Unit Tests: Run Jest Unit Test Suite
|
||||
yarn test:unit
|
||||
|
||||
# For E2E (end-to-end) Tests: Run Jest E2E Suite
|
||||
yarn e2e:serve
|
||||
# on another terminal window
|
||||
yarn test e2e
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
In order to contribute and submit PRs to improve the **Zepio** codebase, please check our [CONTRIBUTING](https://github.com/ZcashFoundation/zepio/blob/master/CONTRIBUTING.md) guide.
|
||||
|
||||
## License
|
||||
|
||||
MIT © Zcash Foundation 2019
|
||||
MIT © Zcash Foundation 2019 zfnd.org
|
||||
|
|
|
|||
Loading…
Reference in New Issue