-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #83 from leo42/BugFixing
Remove outdated info from README
- Loading branch information
Showing
1 changed file
with
36 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,59 @@ | ||
# BroClanWallet | ||
|
||
# BroClanWallet | ||
Bro Clan is a multisig Wallet for the Cardano ecosystem. | ||
|
||
## Running BroClan: | ||
|
||
It consists of 3 components: | ||
- The Main Wallet in React | ||
- The Sync Service that comunicates with the UI instances and the DB to deliver syncronization services | ||
- The Passthrough API that forwords requests for data from the users to blockfrost. | ||
|
||
|
||
You can run access this app via our servise on broclan.io | ||
|
||
|
||
|
||
## Running BroClan: | ||
We also provide dockerfiles and docker Images for all components. | ||
|
||
You can run access this app via our servise on broclan.io | ||
|
||
We also provide dockerfiles and docker Images for all components. | ||
### To run the latest version with docker: | ||
|
||
To run the latest version with docker: | ||
```sh | ||
docker run -it -p 80:80 leo42/broclan:latest | ||
|
||
docker run -it -p 80:80 leo42/broclan:latest | ||
|
||
``` | ||
|
||
|
||
To run a specific version replace `latest` with `<version>` | ||
|
||
To run from code: | ||
|
||
|
||
### To run from code: | ||
|
||
```sh | ||
cd Fe | ||
npm install | ||
npm run start | ||
|
||
cd Fe | ||
|
||
npm install | ||
|
||
npm run start | ||
|
||
``` | ||
|
||
|
||
|
||
|
||
# Developing against BroClan | ||
|
||
|
||
|
||
|
||
## Developing against BroClan | ||
## Best practices | ||
|
||
|
||
|
||
# Best practices | ||
Critical code is all inside the "wallets.js" file, this allows for much reliable developlment, since I can audit this one relatively small file and ensure safe operation of the entire app. | ||
|
||
Critical code is all inside the "wallets.js" file, this allows for much reliable developlment, since I can audit this one relatively small file and ensure safe operation of the entire app. | ||
|
||
React componenents are broken down under the "Components" folder, more smaller components are always preferable. | ||
React componenents are broken down under the "Components" folder, more smaller components are always preferable. | ||
|
||
The backend is entirely hosted in 1 file for each component, that is because most of the logic and functionality is all in happening in the frontend. |