Skip to content
This repository has been archived by the owner on Jan 28, 2025. It is now read-only.

(Chore) Replace Default/Placeholder Readme.md with Descriptive Content #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

(Chore) Replace Default/Placeholder Readme.md with Descriptive Content #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 27 additions & 15 deletions docs/developer-guides/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
# Wallet Developer Guide

## Getting Super Powers
This section guides you through developing GoodDollar based wallets.
It offers a walkthrough of a tutorial app called (GoodBootstrap)[https://github.com/GoodDollar/GoodBootstrap] to introduce you to each submodule GoodDollar offers to wallet developers.

Becoming a super hero is a fairly straight forward process:
## [Getting Started](https://docs.gooddollar.org/developer-guides/getting-started

```
$ give me super-powers
```
The getting started section includes guides on setting up your development environment, a helpful [quick-start](https://docs.gooddollar.org/developer-guides/getting-started#quick-start) module, and a more comprehensive [complete guide](https://docs.gooddollar.org/developer-guides/getting-started#complete-guide).

{% hint style="info" %}
Super-powers are granted randomly so please submit an issue if you're not happy with yours.
{% endhint %}
## [Routing](https://docs.gooddollar.org/developer-guides/routing)

Once you're strong enough, save the world:
This section explains how navigation is handled in the GoodBootstrap tutorial app.

{% code title="hello.sh" %}
```bash
# Ain't no code for that yet, sorry
echo 'You got to trust me on this, I saved the world'
```
{% endcode %}
## [User Storage](https://docs.gooddollar.org/developer-guides/user-storage)

This section explains how the GooDAPP submodule uses the GunDB P2P storage network to store user data with instructions for extension.
It also covers authentication.

## [Good Wallet](https://docs.gooddollar.org/developer-guides/good-wallet)

This section documents the `GoodWallet.js` module, the core submodle that covers all basic wallet functionality.

## [Face Recognition](https://docs.gooddollar.org/developer-guides/face-recognition)

This section describes the Face Recognition process, a core part of GoodDollar's identification process

## [Building Blocks](https://docs.gooddollar.org/developer-guides/building-blocks)

This section describes reusable components that have been added to GoodBootstrap for easy and efficient UI development.

## [Blockchain Events](https://docs.gooddollar.org/developer-guides/blockchain-events)

This section explains how the GooDAPP submodule listens for Events, a Solidity abstraction on top of the Ethereum Virtual Machine.

## [Creating Font With Icons](https://docs.gooddollar.org/developer-guides/create-font-with-icons)

This section explains how to convert SVG data into a custom font for use around the GoodBootstrap app.