dayofr/FOE-Tools.github.io

Set of tools for Forge Of Empire

FOE Tools

This repo is the website of FOE Tools, a set of tools for Forge of Empires.

Install

Using npm:

npm install # or yarn install

Start the server

Using npm:

npm start # or yarn start

Start in development mode

Using npm:

npm run dev # or yarn run dev

Build a static site

Build the project in production mode:

Using npm:

npm run build # or yarn run build

The generated static site will be placed in dist/.

Generate all files for production (or test for production):

npm run generate:gh # or yarn run generate:gh

Note: You need an HTTP server to test with generated. You can use http-serve.

Tests

To run all test just execute this command:

npm run test

Unit test

You can run unit test with:

npm run test:unit

If you want to run in watch mode just add :watch:

npm run test:unit:watch

End-to-end

You can run unit test with:

npm run test:e2e

TODO

See issues.

Contributing

See CONTRIBUTING.md

Changelog

See CHANGELOG.md

Code of Conduct

This project adheres to the Contributor Covenant. By participating in this project you agree to abide by its terms.

Contributors

See CONTRIBUTORS.md

License

MIT