Code Monkey home page Code Monkey logo

armory-react's Introduction

Guild Wars 2 Armory

Build Status Dependencies Dev Dependencies Join the chat at https://gitter.im/gw2armory/Lobby codecov

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!

Quick Start

git clone https://github.com/madou/armory-react.git
cd armory-react
npm install
cp src/config/local.sample.js src/config/local.js // local.js isn't checked in so you'll have to make one yourself.

Testing

npm run tdd // UNIT TESTS + WATCHER
npm test // FULL TEST (lint/flow/coverage+unit)

Website

npm run dev // DEV BUILD
npm run start // PROD BUILD

Embeds

npm run dev:embeds // DEV BUILD
npm run start:embeds // PROD BUILD

Technologies

React, Redux, Flow, Webpack, LESS, Mocha/enzyme/chai/sinon, nyc/Coveralls

Notes for Local Development

  • If running locally make sure you add a local.js to the src/env/ folder. Look at local.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 to localhost if running the api locally.
  • We use pre-commit to run commands before checking in. This will run npm test which covers linting, flow errors, and tests.

Deployments

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.

Standard npm version is used for deployments.

npm version major|minor|patch

This will increment the version, update CHANGELOG.md (anything under Unreleased will be moved to a version), and push commits/tags to git.

Redux Dev Tools

Enabled in dev mode only, go install the extension and then open it while running the armory locally.

Pull Requests

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!

Quick Issues

ยฉ 2015-present gw2armory.com

armory-react's People

Contributors

dxcx avatar fusek07 avatar iniis avatar irina-kuntsevich avatar itsdouges avatar lunuslupus avatar madou avatar mickeyjc avatar milesred avatar protodaniel avatar stygiansabyss avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.