CrazyAuctions/README.md
2023-11-11 12:53:47 -05:00

4.1 KiB


crazyauctions

Contributors Forks Stargazers Issues GPU License Contact CodeFactor

Paper Purpur

Auction off your items in style!
Explore the docs »

Report Bug · Request Feature · Get Support

Table of Contents
  1. Getting Started
  2. Roadmap
  3. Contributing
  4. License
  5. Contact

Resource Page

Beta Builds

All beta builds will be on Modrinth marked as beta.

Modrinth

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.

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 assemble task.
    ./gradlew assemble
    

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.