CrazyAuctions/README.md

101 lines
4.4 KiB
Markdown
Raw Normal View History

2023-11-11 18:53:47 +01:00
<br />
2020-02-26 19:06:56 +01:00
2023-11-11 18:53:47 +01:00
<div align="center">
2022-07-08 02:10:11 +02:00
2024-03-05 18:08:54 +01:00
[![CrazyAuctions](https://raw.githubusercontent.com/RyderBelserion/Assets/main/crazycrew/webp/CrazyAuctionsBanner.webp)](https://modrinth.com/plugin/crazyauctions)
2023-11-11 18:53:47 +01:00
[![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]
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
![Paper](https://cdn.jsdelivr.net/gh/intergrav/devins-badges/assets/compact/supported/paper_vector.svg)
![Purpur](https://cdn.jsdelivr.net/gh/intergrav/devins-badges/assets/compact/supported/purpur_vector.svg)
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
<p align="center">
2024-03-05 18:08:54 +01:00
A crates plugin that offers quality crates with ease!
2023-11-11 18:53:47 +01:00
<br />
2024-03-05 18:08:54 +01:00
<a href="https://docs.crazycrew.us/crazyauctions/home"><strong>Explore the docs »</strong></a>
2023-11-11 18:53:47 +01:00
<br />
<br />
2024-03-05 18:08:54 +01:00
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues/new?assignees=ryderbelserion&labels=bug&projects=&template=bugs.yml&title=%5BBug+Report%5D%3A+">Report Bug</a>
2023-11-11 18:53:47 +01:00
·
2024-03-05 18:08:54 +01:00
<a href="https://github.com/Crazy-Crew/CrazyAuctions/issues/new?assignees=&labels=feature&template=feature_request.md&title=%5BFeature%5D+">Request Feature</a>
2023-11-11 18:53:47 +01:00
·
<a href="https://discord.gg/badbones-s-live-chat-182615261403283459">Get Support</a>
</p>
</div>
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
<!-- 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>
2022-07-08 02:10:11 +02:00
2024-03-05 18:08:54 +01:00
### Resource Page
[![Hangar](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/compact/available/hangar_46h.png)](https://hangar.papermc.io/CrazyCrew/CrazyAuctions)
[![Modrinth](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/compact/available/modrinth_46h.png)](https://modrinth.com/user/plugin/CrazyAuctions)
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
## Getting Started
How to get started with contributing / maintaining your own version of CrazyAuctions!
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
### Prerequisites
A list of things necessary to make sure you can build CrazyAuctions properly.
* Intellij IDEA
* > https://www.jetbrains.com/idea/download/
* Gradle
2022-07-08 02:10:11 +02:00
2023-11-11 18:53:47 +01:00
### 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.
2024-03-05 18:08:54 +01:00
3. Run the clean assemble task.
2023-11-11 18:53:47 +01:00
```gradle
2024-03-05 18:08:54 +01:00
./gradlew clean assemble
2023-11-11 18:53:47 +01:00
```
## Roadmap
2024-03-05 18:08:54 +01:00
Check our public [trello board](https://trello.com/b/bzQ5TwXo) for our current plans, any bugs and general tracking of the project progress.
2023-11-11 18:53:47 +01:00
## 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`)
2024-03-05 18:08:54 +01:00
5. Open a Pull Request to the `main` branch to add your feature/fix.
2023-11-11 18:53:47 +01:00
## 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
2024-03-05 18:08:54 +01:00
[discord-url]: https://discord.gg/badbones-s-live-chat-182615261403283459
2023-11-11 18:53:47 +01:00
[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