AFKBuilder

^{version: 2.3.26}

AFKBuilder is a tool designed to help players build, share, and use community made team compositions for AFK Arena.

Getting Started

This project uses Svelte as the main front end library. All game logic runs in Javascript on the client side. No user information is shared outside of the application. User data is saved on the browser's local storage. Caution: Be sure to make a backup of your comps and hero list before clearing your browser data or clearing the app data.

Prerequisites

To compile, you must have NodeJS >=18.12.1 installed.

Installing

1. Clone a copy of the repository
   1. cd /project/directory
   2. git clone https://github.com/Dae314/AFKBuilder.git
2. Install the necessary packages
   1. cd /project/directory/AFKBuilder
   2. npm install
3. Start up a development environment using npm
   1. npm run dev
4. RECOMMENDED: track all branches
   1. git checkout dev

Deployment

1. Enter the project directory
   1. cd /project/directory
2. Merge changes from the dev branch into main
   1. git checkout dev
   2. git pull origin dev
   3. git checkout main
   4. git merge --no-ff dev
   5. Recommend performing local testing here.
      1. Fix any issues found by committing changes to main.
      2. Update readme and versions.
   6. git push origin main
3. Run the deployment script
   1. npm run deploy
   2. App should be available at https://afkbuilder.com/
4. Cleanup the repo after deployment
   1. git commit -a -m "Deploy to gh-pages"
   2. git tag <version>
   3. git push origin main
   4. git push --tags
5. Recreate the dev branch for continued development
   1. git branch -d dev
   2. git checkout -b dev

Built With

• NodeJS - JS Development Environment
• Svelte - Front End Library

Contributing

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

Versioning

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

Authors

• Dae314 - Maintainer - Dae314
• Wyatt Rice - Designer - Wyatt Rice

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• PurpleBooth - for the README.md and CONTRIBUTING.md templates