The purpose of this project is to develop a new web frontend for the FSEconomy Game World. We're seeking to achieve the following design goals:
- Improved responsiveness
- Enhanced accessibility
- Improved user experience on touch screen devices
- Improved visualisation and navigation of data
- Improved technical maintainability
The static website built from this repository is publicly accessible on Heroku. This preview represents the state of the blessed repository's master branch, using continuous deployment.
Working on this project follows a specific workflow, relying on automation tools such as gulp. Follow the steps described below to get up and running:
- node.js (8.x recommended)
- npm (5.7 or newer recommended)
- gulp 4 installed globally (
npm install -g gulp@^4.0
)
- Run
npm install
to retrieve all dependencies - Use
gulp
to build the website (result in./public
) - Use
gulp dev
to build website dynamically, run it in browser and monitor files for changes.
The second option is what you want most of the time when working on the source code of this project.
We gladly accept contributions, fixes and improvements. To submit them, fork the repository, commit your changes to a feature branch within your fork, and create a pull request.