mirror of
https://github.com/Crazy-Crew/CrazyAuctions.git
synced 2024-11-10 10:10:22 +01:00
111 lines
4.1 KiB
Markdown
111 lines
4.1 KiB
Markdown
<br />
|
|
|
|
[](https://modrinth.com/plugin/crazyauctions)
|
|
|
|
<div align="center">
|
|
|
|
[![Contributors][contributors-shield]][contributors-url]
|
|
[![Forks][forks-shield]][forks-url]
|
|
[![Stargazers][stars-shield]][stars-url]
|
|
[![Issues][issues-shield]][issues-url]
|
|
[![GPU License][license-shield]][license-url]
|
|
[![Contact][discord-shield]][discord-url]
|
|
![CodeFactor][codefactor-shield]
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
Auction off your items in style!
|
|
<br />
|
|
<a href="https://github.com/Crazy-Crew/CrazyAuctions/wiki"><strong>Explore the docs »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/Crazy-Crew/CrazyAuctions/discussions/categories/feature-requests">Request Feature</a>
|
|
·
|
|
<a href="https://discord.gg/badbones-s-live-chat-182615261403283459">Get Support</a>
|
|
</p>
|
|
</div>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#getting-started">Getting Started</a>
|
|
<ul>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#installation">Installation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#roadmap">Roadmap</a></li>
|
|
<li><a href="#contributing">Contributing</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
## Resource Page
|
|
|
|
### Beta Builds
|
|
All beta builds will be on Modrinth marked as beta.<br>
|
|
|
|
<a href="https://modrinth.com/plugin/crazyauctions"></a>
|
|
|
|
## 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
|
|
```sh
|
|
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.
|
|
```gradle
|
|
./gradlew shadowJar
|
|
```
|
|
|
|
## Roadmap
|
|
|
|
Check our public [trello board](https://trello.com/b/CcPYmsBt) 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`](/LICENSE) for more information.
|
|
|
|
[discord-shield]: https://img.shields.io/discord/182615261403283459.svg?style=flat&logo=appveyor
|
|
[discord-url]: https://discord.gg/crazycrew
|
|
|
|
[contributors-shield]: https://img.shields.io/github/contributors/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
|
|
[contributors-url]: https://github.com/Crazy-Crew/CrazyAuctions/graphs/contributors
|
|
[forks-shield]: https://img.shields.io/github/forks/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
|
|
[forks-url]: https://github.com/Crazy-Crew/CrazyAuctions/network/members
|
|
[stars-shield]: https://img.shields.io/github/stars/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
|
|
[stars-url]: https://github.com/Crazy-Crew/CrazyAuctions/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
|
|
[issues-url]: https://github.com/Crazy-Crew/CrazyAuctions/issues
|
|
[license-shield]: https://img.shields.io/github/license/Crazy-Crew/CrazyAuctions.svg?style=flat&logo=appveyor
|
|
[license-url]: https://github.com/Crazy-Crew/CrazyAuctions/blob/master/LICENSE
|
|
|
|
[codefactor-shield]: https://img.shields.io/codefactor/grade/github/crazy-crew/CrazyAuctions/main?style=flat&logo=appveyor
|