README.md

eosDAC Client

Purpose

This is the member client where the DAC members will interface with the deployed smart contract code. The code is written in javascript using Vue.js and Quasar Framework.

Pre-Requisites

You want to be able to read javascript code and have a basic understanding of frontend web development. If you want to simply change the assets to your DAC's messaging, branding, and images then the process is not too difficult.

Original Design document.

Install

yarn is required to install

$ git clone https://github.com/eosdac/eosdac-client.git
$ cd eosdac-client
$ yarn

Customize the eosdac-client

Visit https://github.com/eosdac/boilerplate-client-extension for more info.

Add custom colors, pages, routes and vuex stores. It's recommended to extend and customize the eosDAC client in the extensions folder so you can pull in future updates without losing your customizations. The boilerplate extension already contains a mandatatory home screen (eosDAC) and a custom example page with dedicated vuex store. You'll also find a component to extend the main menu. In production you might want to manage the contents of the extention folder as a git submodule. The command below will simply clone the remote repo in the src/extensions folder.

cd eosdac-client
yarn add_extensions https://github.com/eosdac/boilerplate-client-extension.git extensions

If you want a tighter coupling between the main repo and your extensions repo you can create a git submodule.

cd eosdac-client
git submodule add https://github.com/your_repo/your_dac-client-extension.git src/extensions

Quickstart

Opens browser window automatically http://localhost:8080

yarn dev

Deployment

Build the project for deployment.

yarn build

You can run the deploy script to checkout the correct release tag and copy the dist/spa-mat files to a dist/deploy folder which you can then make the root folder of your nginx website.

Example:

$ deploy.sh v0.3.1 true

That will run tag v0.3.1 locally.

$ deploy.sh v0.3.1

That will build v0.3.1 and copy the results to the dist/deploy folder.

If you want to build and run specifically for the jungle tesnet, you can run DEFAULT_NETWORK=jungle quasar build