Skip to content

AbstractMelon/Azurite

Github logo

Azurite

Version Contributers GitHub issues GitHub commits

Welcome to Azurite! This project aims to provide a platform for sharing and discovering mods for various games, similar to Thunderstore.

Table of Contents

Introduction

Azurite is a web application (and maybe a mod manager later?) where users can upload, share, and download mods for their favorite games. It provides a user-friendly interface for browsing mods, searching for specific ones, and managing your own uploads.

Features

  • Exsists: The site exsists! New stuff comming soon!
  • Mod Upload: Allow users to upload their mods, including descriptions, screenshots, and version information.
  • Mod Listing: Display a list of available mods with sorting and filtering options.
  • Search Functionality: Enable users to search for mods based on keywords, categories, or other criteria.
  • Mod Details: Show detailed information about each mod, including descriptions, download links, and user ratings.
  • User Interaction: Allow users to rate mods, leave comments, and interact with other users.
  • Responsive Design: Ensure the site is accessible and usable across different devices and screen sizes.

Demo

Link to Demo - Add a link to a live demo of your site if available.

Installation

To run azurite locally, follow these steps:

  1. Clone the repository: git clone https://github.com/Abstractmelon/azurite.git
  2. Navigate to the project directory: cd azurite
  3. Install dependencies: npm install
  4. Setup needed files: npm run setup
  5. Start the development server: npm run dev

Usage

Once the development server is running, you can access the site in your web browser at http://localhost:3000.

Contributing

Contributions to Azurite are welcome! If you'd like to contribute, please follow these guidelines:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Commit your changes with clear and descriptive messages.
  3. Push your branch to your fork and submit a pull request to the main repository.

License

This project is licensed under the GNU v3 License. Feel free to use, modify, and distribute it as you see fit.