HelloKitchen - KDS Front-end

Welcome to the HelloKitchen KDS Front-end repository! This project powers the Kitchen Display System functionality of the HelloKitchen platform.

---

🛠️ Project Setup

To get started, install the required dependencies:

$ npm install

⚙️ Environment Configuration

Create a .env file at the root of the project with the following variables:

REACT_APP_BACKEND_URL= [Database URL]
REACT_APP_BACKEND_PORT= [Database port]
REACT_APP_NBR_RESTAURANT= [ID of the restaurant] // DEV purposes, will be removed in a future version
REACT_APP_SALT_HASH= [SALT HASH used for the password]

🚀 Running the Project

You can compile and run the project using the following commands:

Development Mode

$ npm run start

🧪 Running Tests

Ensure code quality with the available tests:

Unit Tests

$ npm run test

📄 Documentation

Comprehensive documentation for the project can be found in the Wiki section of the GitHub repository.

🤝 Contribution Guidelines

Currently, this project does not accept external contributions. Feel free to explore the codebase, but contribution via pull requests is restricted.