Skip to content

energywebfoundation/ewx-marketplace-web-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

EWX Marketplace Web App

The web app version of EWX Marketplace desktop dApp which provides access to everything on the EWX ecosystem

Download · User Manual · Docs

Table of Contents
  1. About The Project
  2. Getting Started
  3. FAQ
  4. Security Audits
  5. Maintainers
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project


Overview

This project contains the web application version of the EWX Marketplace desktop application (dApp). It serves as a comprehensive gateway to the dynamic EWX ecosystem. Our platform is designed to facilitate seamless interactions within the EWX, offering an intuitive interface for managing digital assets and engaging with decentralized services. This has all the features available on the desktop application minus the ability to run workers on the device.

Key Features

  • EWT Bridge (Lifting & Lowering): Our dApp provides a robust interface for efficient EWT transfers between chains in our ecosystem - the Energy Web Chain (EWC) and EWX. This feature simplifies the process of asset migration, ensuring a smooth user experience.
  • Galaxy Subscriptions (Solution Groups): Engage directly with worker node networks through our unique subscription model. Users can participate in decentralization efforts, run worker node flows included in the solution groups, and earn rewards for their contributions.
  • Worker Node Management: We offer a suite of tools allowing users to manage their subscribed Galaxy Subscriptions effectively. These include options to unsubscribe, monitor and claim rewards, and view reward history.
  • User-Friendly Interface: We prioritize user experience, ensuring our platform is accessible to both novices and experienced users in the blockchain space.
  • Advanced Security Measures: Security is a cornerstone of our application, implemented through cutting-edge protocols to safeguard user data and transactions.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo
git clone https://github.com/energywebfoundation/ewx-marketplace-web-app.git
  1. Open the web application folder
cd ew-marketplace
  1. Install NPM packages
npm install
  1. Fill the environment variables, .env template can be found here.

  2. Open the web application folder

cd src/web
  1. Install NPM packages
npm install
  1. Fill also the environment variables of the web app, .env template can be found here. Note the VITE_ prefix.

  2. Run the project. While being on the /src/web folder, execute the following command

npm run dev

Environment variables

Name Sample Value Description
SERVICE_NAME EWF-MARKET Marketplace service name
SERVICE_ACCOUNT EWF-MARKET-WORKER Marketplace service account
POLKADOT_ENDPOINT https://wnp-rpc.mainnet.energywebx.com Polkadot public endpoint
POLKADOT_PALLET_ENDPOINT https://wnp-rpc.mainnet.energywebx.com Polkadot public endpoint
VOLTA_RPC_ENDPOINT https://rpc.energyweb.org Volta RPC endpoint
VOLTA_WS_ENDPOINT wss://rpc.energyweb.org/ws Volta WebSocket endpoint
SYMMETRIC_ALGORITHM aes-256-cbc Symmetric Algorithm
IPFS_API_KEY IPFS API Key
IPFS_SECRET_KEY IPFS Secret Key
IPFS_URL https://ipfs.infura.io:5001 IPFS URL
IPFS_CONTEXT_PATH /api/v0/cat?arg= IPFS Context Path
SMART_CONTRACT Smart Contract address
WC_PROJECT_ID ba592d626408bb37e94c6a69ab611dab WalletConnect project ID
AVT_CONTRACT_ADDRESS 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee Aventus contract address
EWC_CHAIN_ID 246 Energy Web Chain ID
EWX_CHAIN_ID 5a51e04b88a4784d205091aa7bada002 Energy Web X Chain ID
WC_RELAY_URL wss://relay.walletconnect.com WalletConnect Relay Websocket URL
ELECTRON_ENABLE_SECURITY_WARNINGS true Enable Electron security warnings
CRON_JOB_SCHEDULE_BASE */1 * * * * Refresh solutions cron job
CRON_JOB_SCHEDULE_USER */30 * * * * * Refresh subscription cron job
CRON_JOB_SCHEDULE_FLOW */30 * * * * * Refresh flow cron job
CRON_JOB_SCHEDULE_EARNED */30 * * * * Refresh earned rewards cron job
CRON_JOB_SCHEDULE_NETWORK */30 * * * * * Refresh network cron job
CRON_JOB_SCHEDULE_PERIOD */30 * * * * * Refresh period cron job
CRON_JOB_SCHEDULE_HEALTHY */30 * * * * * Refresh validate solution active cron job
CRON_JOB_SCHEDULE_ENGINE */15 * * * * Refresh worker engine status cron job
EWX_CHECK_UA ewx-marketplace User Agent
WHITELIST_URL https://marketplace-cdn.energyweb.org/ewf_marketplace_whitelist.json Whitelist URL
EWC_EXPLORER_URL 'https://explorer.energyweb.org/tx' Energy Web Chain Explorer URL
EWX_EXPLORER_URL 'https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fpublic-rpc.mainnet.energywebx.com%2F#/explorer/query' Energy Web X Explorer URL
COINGECKO_EWT_USD_API_URL https://api.coingecko.com/api/v3/simple/price?ids=energy-web-token&vs_currencies=Usd CoinGecko EWT to USD price API
IS_TEST_VERSION true Is Test Version
HERO_BANNER_DATA_URL https://marketplace-cdn.energyweb.org/remote-resources/hero-banner/hero-banner-data.json Hero Banner URL
WORKER_CARD_DATA_URL https://marketplace-cdn.energyweb.org/remote-resources/worker-card/worker-card-data.json Worker Card URL
NOTIFICATIONS_DATA_URL https://marketplace-cdn.energyweb.org/remote-resources/notifications/notifications.json Notifications URL
BLACKLISTED_SOLUTION_GROUPS_DATA_URL https://marketplace-cdn.energyweb.org/remote-resources/blacklisted-solutions/blacklisted-solutions-data.json Blacklisted Solution Groups URL

Run

  1. Run the application in development mode
npm run dev
  1. Run the Storybook to view frontend components
npm run storybook

Build

  1. Create a build by selecting a OS tag, currently available tags are mac, win and linux. This command will output both the installer and the executable version of the application in the /dist folder.
npm run build:<os_tag>

(back to top)

FAQ

  • How can I get Volta Token (VT) for testing?

(back to top)

Security Audits

(back to top)

Maintainers

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

This project is licensed under the GNU General Public License v3.0 or later - see the LICENSE file for details

(back to top)

Contact

Project Link: https://github.com/energywebfoundation/ew-marketplace/

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •