Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 7.97 KB

README.md

File metadata and controls

103 lines (77 loc) · 7.97 KB
Raw

D2ArmorPicker

All Contributors

D2ArmorPicker is a small tool to min-max your armor stats with only a few clicks. Visit the page here: https://d2armorpicker.com

Contribution

Development

  1. Run npx husky-init && npm install to install dependencies.
  2. Duplicate the .env_example to .env_dev.
  3. Create a Bungie API key. For this, head over to https://www.bungie.net/en/Application and create a new application.
    • Set the OAuth Client Type to Confidential and the redirect URL to https://localhost:4200/.
    • Select the Scopes Read your Destiny 2 information and Move or equip Destiny gear and other items.
    • Set Origin Header to https://localhost:4200.
    • Copy the API key and paste it to D2AP_BUNGIE_API_KEY in the .env_dev file.
    • Copy the OAuth client_id and paste it to D2AP_BUNGIE_CLIENT_ID in the .env_dev file.
    • Copy the OAuth client_secrety and paste it to D2AP_BUNGIE_CLIENT_SECRET in the .env_dev file.
  4. Start the development server with npm start (or npm run start). The server will be available at https://localhost:4200/. This page will automatically update whenever you change anything in the code.
    • Ignore the "invalid certificate" error your browser will show you. You need HTTPS to be able to use the Bungie Authentification.

Building Production and Beta packages

  • Copy .env_dev to .env and/or .env_beta.
  • To build a production package, set the environment flag PRODUCTION=1.
  • To build a beta package, set the environment flag BETA=1.

Then you can use npm run build.

Deployment

You can also deploy the page to a "github pages" page. Please note that I strongly discourage hosting alternative D2AP installations, let's make this one as awesome as possible.

  1. Set the environment flag BETA=1 or PRODUCTION=1.
  2. Modify the deploy script in package.json and remove--base-href=/ --cname=d2armorpicker.com. The same for the beta command. If you deploy to yourname.github.io/fancyrepo, then you may have to set --base-href=/fancyrepo.
  3. npm run deploy (given you forked the repository first).

Guidelines

  • We use husky to execute some commit hooks.
  • We use eslint to make sure we have the same code style.
  • We use prettier to make sure we have the same code formatting.
  • We are using commitlint to make sure we all have the same commit structure. The template used is @commitlint/config-angular.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Mijago
Mijago
💻 🤔 🚇 ⚠️ 📖 🚧 📆 📓 👀		 TheYeshir
TheYeshir
📆 🤔 👀 📓 💬		 Mojo
Mojo
📆 🤔 📓 💬 💻		 Ben Hollis
Ben Hollis
💻		 nznaza
nznaza
🚧 💻		 Ciarán Walsh
Ciarán Walsh
💻 🚧		 Slavi Stoev
Slavi Stoev
🔣
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Copyright (c) Mijago 2023.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.