Rust Conveyor Filters

This project is a web application for generating, editing, and sharing Rust conveyor filters. It is built with Next.js and TypeScript, and leverages various libraries and tools to provide a seamless user experience.

✨ Features

• 🎮 Visual filter builder that mirrors the in-game experience
• 💾 Import your existing filters directly from the game
• 📤 Export configurations with one click
• 🌐 Browse and learn from other players' setups
• 📱 Full mobile support for planning on the go

🚀 Quick Start

Prerequisites

You'll need:

• Node.js
• Package manager (npm, yarn, pnpm, or bun)

Installation

1. Clone and enter the project:

   git clone https://github.com/tostesdaniel/rust-conveyor-filters.git
   cd rust-conveyor-filters

2. Install the dependencies:

   npm install   # or yarn/pnpm/bun install

3. Fire it up:

   npm run dev   # or yarn/pnpm/bun dev

Running the Development Server

Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Visit http://localhost:3000

🏗️ Project Structure

rust-conveyor-filters/
├── src/
│   ├── actions/               # Server actions
│   ├── app/                   # Next.js app router pages and layouts
│   │   ├── (app)/             # Main application pages
│   │   ├── (legal)/           # Terms and privacy pages
│   │   ├── (resources)/       # Public resources
│   │   └── api/               # Route handlers
│   ├── components/            # Reusable React components
│   │   ├── about/             # About page components
│   │   ├── analytics/         # Analytics hooking
│   │   ├── donate/            # Donation related components
│   │   ├── feedback/          # Feedback related components
│   │   ├── filters/           # Public filters components
│   │   ├── landing-page/      # Home page components
│   │   ├── my-filters/        # User filters components
│   │   ├── steam-guide/       # Steam guide components
│   │   └── ui/                # Shared UI components
│   ├── config/                # App metadata & config
│   ├── db/                    # Database schema & setup
│   │   └── seed-data/         # Seed data for the database
│   ├── hooks/                 # Custom React hooks
│   ├── lib/                   # Utility functions and constants
│   │   ├── donation/          # Donation webhook validation
│   │   ├── queries/           # Database queries
│   │   ├── stats/             # Cron jobs
│   │   └── utils/             # Utility functions
│   ├── providers/             # React context providers
│   ├── schemas/               # Form schema definitions
│   ├── scripts/               # Scripts for the project
│   │   └── monthly-update/    # Monthly update script
│   ├── services/              # Services for the project
│   └── types/                 # TypeScript type definitions
└── public/                    # Static assets
    ├── icons/                 # App icons
    ├── images/                # Static images
    └── items/                 # Item assets

🛠️ Built With

🤝 Contributing

Quick Start

Check out our CONTRIBUTING.md guide for detailed instructions on getting started.

Ways to Contribute

• 🐛 Report bugs and issues
• 💡 Suggest new features or improvements
• 📝 Improve documentation
• 🔧 Submit pull requests
• 🗣️ Share the project with others

🌟 Contributors Wall

Thanks to all the contributors who take their time to make this project better!

Daniel Tostes

Nic

📝 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

📬 Get in Touch

Have questions? Join our Discord community or email me at tostes.dev@gmail.com.

---

Made with ❤️ for the Rust community

Join Discord • Report Bug • Request Feature