Kontinum is a full-stack application designed to streamline bar management, offering an intuitive interface for managing inventory, orders, and customer interactions. The backend is built in Kotlin using the Ktor framework for a high-performance and reactive architecture. The frontend, still in its draft phase, is developed with React to ensure a smooth and modern user experience. Yarn is used as the package manager for the frontend.
Follow these instructions to install and run Kontinum on your system.
- JDK (Java Development Kit) for Kotlin
- Gradle for building the backend
- Node.js and Yarn for the frontend
-
Clone the repository and navigate to the backend directory:
git clone https://github.com/ToniDarodda/Kontinum.git cd kontinum/backend -
Build and run the backend server:
gradle build gradle run
-
Navigate to the frontend directory:
cd ../frontend -
Install dependencies with Yarn:
yarn install
-
Start the frontend application:
yarn start
The application will be accessible at http://localhost:3000.
For a detailed look at the design aspects of Kontinum, check out our Figma design file.
To view the database model for Kontinum, visit our Lucidchart diagram.
- Inventory Management: Real-time tracking of beverage stocks.
- Orders: Simplified handling of customer orders.
- User Interface: Clean and intuitive interface.
Note: The project is under development. The backend is functional, but the frontend is still in the draft phase, with only a few pages designed so far.
Contributions are welcome to help complete the frontend and enhance backend functionalities. To contribute:
- Fork the project.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some amazing features'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
This project is distributed under the MIT License. See the LICENSE file for more information.