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.
Ensure you have the following installed on your machine:
- Node.js
- npm, yarn, pnpm, or bun
-
Clone the repository:
git clone https://github.com/tostesdaniel/rust-conveyor-filters.git cd rust-conveyor-filters -
Install dependencies:
npm install # or yarn install # or pnpm install # or bun install
Start the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
The project is organized as follows:
components/: Contains all the React components used in the application.app/: Contains the Next.js pages and layout components.assets/: In-game items data and images. Necessary for seeding database.config/: Configuration files for the project.db/: Database schema and seed files.public/: Static assets like images and icons.styles/: Global styles and Tailwind CSS configuration.types/: TypeScript type definitions.utils/: Utility functions and helpers.
Create a .env.local file in the root of your project and add the necessary environment variables:
DATABASE_URL=your_database_urlTailwind CSS is used for styling. Configuration can be found in tailwind.config.ts.
The project uses ESLint and Prettier for code linting and formatting. Configuration files are .eslintrc.json and .prettierrc.
This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
Contributions are welcome! Please open an issue or submit a pull request.
For any inquiries, please contact at tostes.dev@gmail.com.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}