DOCS: Handbuch(German)
Rebound360 is a desktop application built with Electron, React, and TypeScript, designed to streamline supplier returns management and internal procurement processes, with integration capabilities for JTL-Wawi.
- Supplier Return Management: Track and manage returns to suppliers efficiently.
- JTL-Wawi Order Integration: View and process returns based on JTL orders.
- Procurement Module: Manage internal purchase requisitions and orders.
- Approval Workflows: Define and manage approval processes for procurement.
- Supplier Management: Keep track of supplier information synced from JTL.
- Document Handling: Upload and view documents related to returns.
- Customizable Settings: Configure database connections, workflows, and custom fields.
- Modern UI: Built with Shadcn/ui and Tailwind CSS.
- Cross-Platform: Runs on Windows, macOS, and Linux thanks to Electron.
COMING SOON
- Framework: Electron
- Frontend: React, TypeScript, Vite
- UI: Shadcn/ui, Tailwind CSS
- State Management: TanStack Query, TanStack Router
- Database (Local): better-sqlite3
- Database (External): MSSQL (for JTL-Wawi Integration)
- Build Tool: Electron Forge
Follow these steps to set up the development environment:
-
Clone the repository:
git clone https://github.com/bl4ckh4nd/rebound360App.git cd rebound360 -
Install dependencies:
npm install
-
Environment Variables:
- Create a
.envfile in the root directory. - Copy the contents of
.env.example(if it exists) or add the necessary variables (likeENCRYPTION_KEY,ENCRYPTION_SALT, JTL Database credentials if needed for direct dev access, etc.). - Note: Sensitive keys like
ENCRYPTION_KEYshould ideally be handled securely, especially for production builds.
- Create a
-
Run the application in development mode:
npm run dev
This command typically starts the Vite dev server for the renderer and runs Electron, enabling hot-reloading.
To build the application for production or create installers:
-
Build the application components:
npm run build
This compiles TypeScript for main/preload/shared and builds the renderer using Vite.
-
Package the application:
- Creates an unpackaged application (e.g., in the
outdirectory).
npm run package
- Creates an unpackaged application (e.g., in the
-
Create installers:
- Creates platform-specific installers (e.g.,
.exe,.dmg,.deb).
npm run make
The installers will be located in the
out/makedirectory. - Creates platform-specific installers (e.g.,
This project is licensed under a custom License - see the LICENSE.md file for details.
Contributions are welcome! Please feel free to open an issue or submit a pull request.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Happy returning!