sefbkn/politeiagui

Politeia GUI

Politeiagui is the web frontent for Politiea, Decred's proposal system.

Requirements

Politeiagui uses node.js and the yarn package manager.

• node

• yarn

• politeiawww

  Note: Politeiagui can be run as a standalone application that uses mock APIs to simulate communicaiton with the Politeia backend (useful if you're only doing UI changes). In this case, politeiawww isn't needed. However, be aware that the Mock APIs are not always up-to-date with the latest changes.

Development

1. Clone this repository

   https://github.com/decred/politeiagui.git

2. Build and run locally.

   Against politeiawww

   To run politeiagui against politeiawww, make sure politeiawww is running and use the following command:

   yarn && yarn start

   Mock APIs (WARNING: may be out of date)

   To run politeiagui using mock APIs that do not communicate with politeiawww (useful for working on UI changes only), run the following command:

   yarn && yarn uidev

Production

To build politeiagui for production deployment, use the following commands:

yarn && yarn build
ls build

Configuration

Politeiagui allow customization of settings and features toggling from enviroment variables. To make this process easier we use dotenv.

Specify your config options by creating a .env file in the root folder of the project. All variables must be preceded by "REACT_APP" as follow:

/.env:

REACT_APP_TITLE="Politeia"
REACT_APP_STAGING=false

It is also possible to specify a preset to be used:

/.env:

REACT_APP_PRESET="POLITEIA"

If the REACT_APP_PRESET is specified, all other specified options in the env file will be ignored.

Testing

Politeiagui has unit tests for its core logic. To run all unit tests run the command:

yarn test

Test coverage is currently provided for (actions/*), (lib/*, reducers/*) and (selectors/*).

Relevant libraries/modules used for testing are:

• Jest - Javascript testing
• fetch-mock - Mock http requests
• redux-mock-store and redux-actions-assertions for testing redux actions.

Contributing

We encourage you to contribute to Politeiagui. Please check How to contribute to Politeiagui for guidelines about how to proceed.

Docker

Politeiagui can also be hosted in a docker container. To build the the docker container, run the following commands:

$ ./bin/build.sh

Then run the container with:

$ docker run -d --rm -p <local port>:80 decred/politeiagui:latest

---

This project was bootstrapped with Create React App. You can find the most recent version of this guide here.