Nuzlocke Tracker

(https://github.com/diballesteros/nuzlocke/actions/workflows/codeql-analysis.yml)

Table of Contents

• About
  • Features
  • How it works
• Getting started
• Running the tests
• Roadmap
• Deployment
• Versioning
• Contributing
• License
• Acknowledgements
• Legal
• Contact

About

https://nuzlocke.netlify.app

Web app to track and record encounters in any Pokémon game. Including custom games!

All Pokémon included up to generation 8.

Built with ReactJS, Create-React-App, Zustand and Semantic UI.

🚀 Features

• Record your encounters with detailed information, including: pokemon, level, gender, ability, nature, item and more!
• Accurate encounter tables for every location
• Level caps for all base games - customizable!
• Add and edit custom games and custom encounter locations
• Search and filter through all encounters - including only missing encounters
• Export, import and share Nuzlocke runs with others!
• Fully integrated damage calculator
• Share, add and edit custom rules and rulesets - including smart rules that alert if they're broken
• View overview and summary of your nuzlocke run
• Dupes clause alerts
• Works offline
• Nickname randomizer
• Details on all gym and Elite Four pokémon for all base games
• Download a summary image
• Build an ideal team with the Team Builder!
• Quick access to details on type effectiveness and natures
• Encounter suggestions
• Soul Link integrations

✨ How it works

• Adding Encounter:

• Editing Encounter:

• Badges:

• Team Builder:

• Damage Calculator:

• Summary Image:

Getting started

🔑 Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• git
• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

💻 Installation

1. Clone the repo

   git clone https://github.com/diballesteros/nuzlocke.git
   cd nuzlocke

2. Install NPM packages

   yarn

3. Run the project locally

   yarn start

Running the tests

This project uses Cypress for testing. To run them:

yarn e2e

In the new window execute any of the *.spec.ts files.

This will run the unit tests:

yarn test

Roadmap

See the open issues for a list of proposed features (and known issues).

Deployment

The project automatically deploys to Netlify when changes are detected on the master branch.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details

Acknowledgements

• Images provided by Bulbapedia
• Icons made by Darius Dan from Flaticon
• Icons made by Roundicons Freebies from Flaticon
• Icons made by Nikita Golubev from Flaticon
• Icons made by Freepik from Flaticon
• Icons made by Vectors Market from Flaticon
• Nickname list provided by Find Nicknames

Legal

Pokémon © 2002-2021 Pokémon. © 1995-2021 Nintendo/Creatures Inc./GAME FREAK inc. TM, ® and Pokémon character names are trademarks of Nintendo.

Contact

Diego Ballesteros - @relatablecoder - [email protected]