Git Product home page Git Product logo

polk-auction-ui's Introduction

Apache 2.0 license

PolkAuction UI

User Interface for the PolkAuction core

Requirements

To be installed :

  • NodeJs

Once node.js is installed, install or upgrade yarn with the following command :

npm install --global yarn

Then install the packages with :

yarn

Build (with Docker)

docker build -t polk-auction-ui .

Run

Note: Polk-auction UI is requesting data from PolkAuction Core, refer to the link above for instructions to run it before running an instance of PolkAuction UI. You can also change the endpoint in the .env configuration file if your Polkauction Core instance's endpoint is different (i.e. you changed it).

Run Locally : yarn start

(Accessible at http://localhost:3000/)

Run with Docker : docker-compose up -d --build polk-auction-ui

(Accessible at http://localhost)

Test

Tests : yarn test

Configuration

In case the URL (IP and/or port) of the polk-auction-server has been changed (either directly or by forwarding URL), you need to adapt the POLK_AUCTION_ENDPOINT value in the .env.prod file

Contributions, issues and PR

We are open to contributions, ideas, issues, etc. Feel free to open a PR or an issue.

For both the issue and the PR, a context is necessary.

polk-auction-ui's People

Contributors

astegmaier avatar crommvardek avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.