just1not2/electorz-frontend

Frontend of the ElectorZ political game, written in ReactJS

ElectorZ - Frontend

ElectorZ is a political game based on geographical strategies.

This repository hosts the frontend of the ElectorZ web application, written in React. The code of the backend is available in the Electorz Backend repository.

Configuration

The entire project configuration is defined in an environment file, of which a template is present in the repository. To bootstrap the configuration, launch the following command:

cp .env.template .env

You may then modify the following environment variables to configure the ElectorZ frontend:

• REACT_APP_FRONT_URL: URL of the frontend
• REACT_APP_BACK_URL: URL of the backend

Installation

You can install the npm dependencies by launching the following command:

npm install

Besides, the ElectorZ backend must be launched for the frontend application to work. The easiest way to meet this requirement is to clone the ElectorZ Backend repository and follow its README.

Launching the application

The ElectorZ frontend application may be launched with the following command:

npm run start

You may then visit http://localhost:3000 to test the website locally.

See Also

• ReactJS official documentation
• React-Leaflet documentation

Contributing to this application

This application started as personal project, but I welcome community contributions to it. If you find problems, please open an issue or create a PR against the ElectorZ Frontend repository.

You can also reach me by email at [email protected].

Licensing

Mozilla Public License Version 2.0.

See LICENSE to see the full text.

Author Information

This application was created in 2022 by Justin Béra.