README.md

Nitro4Friends

Earn Nitro by inviting your friends!

Mockup by CoasterFreakDE

---

📝 Table of Contents

• About
• Getting Started
• Usage
• Contributing
• License
• Contact

🧐 About

Nitro4Friends is a Website that allows you to earn Nitro by inviting your friends to the site. It is a simple and easy to use website that is completely free and open source. It finances itself by showing ads on the site.

🏁 Getting Started

Prerequisites

• Gradle
• Java 17
• MariaDB

Installing

1. Clone the repository
2. Run gradle build
3. Run gradle shadowJar
4. Copy the .env.example file and rename it to .env
5. Fill in the .env file
6. Run the jar file
7. Open the website
8. Done!

🎈 Usage

Invite your friends

Invite your friends to the website and earn Credits for it!

Redeem your Nitro

Redeem your Nitro for your earned credits and get your Nitro Code!

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

📝 License

This project is GPL 3.0 licensed. Read more about it here.

📧 Contact

If you have any questions about the project, feel free to contact me via Email or Discord.