CrazyAuctions/README.md

Auction off your items in style!
Explore the docs »

Report Bug · Request Feature · Get Support

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Roadmap
3. Contributing
4. License
5. Contact

Resource Page

Beta Builds

All beta builds will be on Modrinth marked as beta.

Getting Started

How to get started with contributing / maintaining your own version of CrazyAuctions!

Prerequisites

A list of things necessary to make sure you can build CrazyAuctions properly.

• Intellij IDEA

  • https://www.jetbrains.com/idea/download/

• Gradle

Installation

1. Clone the repo

   git clone https://github.com/Crazy-Crew/CrazyAuctions.git
   

2. Open the repository using Intellij IDEA & wait until it finishes downloading/indexing.
3. Run the shadowJar task.

   ./gradlew shadowJar
   

Roadmap

Check our public trello board for our current plans, any bugs and general tracking of the project progress.

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/yourfeature)
3. Commit your Changes (git commit -m 'your amazing feature.')
4. Push to the Branch (git push)
5. Open a Pull Request to the dev branch to add your feature/fix.

License

Distributed under the MIT License. See LICENSE for more information.