Guild Wars 2 Armory is an easy way to find, view, and share users, characters, and guilds with your friends on your mobile and PC! Join today and start sharing!
git clone https://github.com/madou/armory-react.git
cd armory-react
yarn // or npm install
cp src/config/local.sample.js src/config/local.js // You need to create a local config yourself!
npm run tdd // UNIT TESTS + WATCHER
npm test // FULL TEST (lint/flow/coverage+unit)
npm run dev // DEV BUILD
npm run start // PROD BUILD
npm run dev:embeds // DEV BUILD
npm run start:embeds // PROD BUILD
- React (view engine)
- Redux (data container)
- Flow (static type checking)
- Webpack (asset bundler)
- LESS (css preprocessor)
- Mocha/enzyme/chai/sinon (testing)
- nyc/Coveralls (code coverage)
- If running locally make sure you add a
local.js
to thesrc/env/
folder. Look atlocal.sample.js
for help. This isn't checked in deliberately so we can play with local settings without affecting git history. - If needed you can get the api over at armory-back. You will have to update your
config/local.js
to point tolocalhost
if running the api locally. - We use
pre-commit
to run commands before checking in. This will runnpm test
which covers linting, flow errors, and tests.
Deployments are triggered to preview.gw2armory.com
via any branch commit, and to gw2armory.com
via any tagged commit to master
branch. Note that master
doesn't reflect what is in production - look for the most recent tagged commit for that.
We use np
.
np major|minor|patch
This will increment the version, update CHANGELOG.md (anything under Unreleased will be moved to a version), and push to git.
Enabled in dev mode only, go install the extension and then open it while running the armory locally.
Feel like contributing? Look at the issues tab (or below in quick issues), or contact me on twitter for help to find something you'd like to work on. Make a pull request against master
when you're ready to share your code!
© 2015-2017 gw2armory.com