Git Product home page Git Product logo

aos-reminders's Introduction

Codeship Status for daviseford/aos-reminders

Discord

https://discord.gg/2nt9Fxp

How to Contribute

If you want to add an army or edit an existing army, please do so! Use the src/factions/sample/ folder as a reference for how things are added!

Feel free to submit a PR for any incorrect/missing rules! I am only human, and the amount of data entry needed for a single army can sometimes be overwhelming.

For more contribution guidelines, check out docs/CONTRIBUTING.md

Contributors

Available Scripts

In the project directory, you can run:

yarn install

If you just downloaded this repository, or if you are getting errors regarding missing packages, run yarn install to download/update dependencies.

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.

yarn lint

Checks your code for formatting or logical errors. Run this before opening a PR, since the CI will fail your branch if you don't pass the linting standards.

yarn build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

yarn analyze

Run after yarn build. Analyzes the build bundle and shows which dependencies and files are taking up space.

yarn verify (Mac/Linux) and yarn verify:win (Windows)

Runs a script that checks rules to see if they're misplaced. Be sure to run this after adding a new army since it can catch some common errors.

yarn intake

Sorts error logs in src/tests/fixtures/intake/.

Pre-commit

I have set this repository up to automatically take care of some chores when you push a commit.

  1. Any special punctuation characters such as , , , and are removed and replaced with ' or ".
  2. Any leading or trailing whitespace is removed from any name, desc, and tag entries.
  3. Periods are added to the end of descriptions if they are missing.
  4. Finally, we use pretty-quick to format the code according to the repository standards.

Deployment

This repository is automatically deployed using CodeShip.

Whenever a commit is pushed to the master branch, the project is built and uploaded to S3.

This happens automatically, so be careful when merging to master! Your changes will immediately be live.

Authenticating Locally

If you want to test or use subscriber features locally, you can do it :)

First, login through Auth0. You can create a fake account - your email doesn't need to be verified.

Then subscribe and go through checkout as usual. You can use any of Stripes test card numbers to complete the transaction. Just enter a test card number, and any expiration date/CVC/ZIP code, and your account will be subscribed.

I like to use card # 4242 4242 4242 4242 since I can just spam my keyboard.

Obviously, this does not work in production :)

Warscroll Builder/Azyr/Battlescribe Import

Found a discrepancy between Warscroll Builder/Azyr/Battlescribe/Warhammer App and AoS Reminders? You have three options:

  1. Open an issue on Github and let us know.
  2. Add to the typo list ([warscroll|azyr|battlescribe|warhammerApp]TypoMap) in src/utils/import/options.ts
  3. Just wait. :) Failed imports are fired off to Google Analytics - we will probably fix your issue within a couple days.

Helpful Commands

Delete all local branches except master

Linux/OSX:

git branch | grep -v "master" | xargs git branch -D

Windows:

git branch | %{ $_.Trim() } | ?{ $_ -ne 'master' } | %{ git branch -D $_ }

API Repositories

Note: These are both private repositories.

Will you ever add units stats or points?

No.

This is something I will never add to AoS Reminders (unless we get a blessing from GW). It gets too close to entirely replacing the need for a battletome, and I don't want GW to think I'm trying to do that. It's a great idea but not one that I will do :)

aos-reminders's People

Contributors

aledegano avatar amcalvert avatar beeglebug avatar benkidd avatar bszonye avatar cptasgard avatar ctcodie avatar daviseford avatar dccourt avatar dependabot[bot] avatar drmartin1998 avatar exonian avatar flui avatar gotsk avatar grzegorzmiazga avatar johnschramm avatar liuseeker avatar lucienlopez avatar mattbarkerdev avatar megabossmike avatar michalgrochowski avatar mmorrison avatar niklasmm avatar paul-anaplan avatar pixeltom avatar redmongrel avatar thundergore avatar wspencermiller avatar zirhark 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.