KIOSKY

An front-end for your fast-food kiosk

Table of Contents

• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

Simply a front-end for your kiosk app, to permit order in your fast-food

---

Features

❯ Authentification
❯ Loyalty Card
❯ Multi-Category
❯ In-person, Pickup

---

Project Structure

└── Kiosky/
    ├── LICENSE
    ├── README.md
    ├── ask-barcode.html
    ├── ask-id.html
    ├── cart.html
    ├── choicemethod.html
    ├── index.html
    ├── order.html
    ├── script.js
    ├── style.css
    └── successful.html

Project Index

KIOSKY/

__root__

style.css

cart.html

choicemethod.html

order.html

script.js

ask-id.html

successful.html

ask-barcode.html

index.html

---

Getting Started

Prerequisites

Before getting started with Kiosky, ensure your runtime environment meets the following requirements:

• Programming Language: HTML

Installation

Install Kiosky using one of the following methods:

Build from source:

1. Clone the Kiosky repository:

❯ git clone https://github.com/MaxenceLebrunDEV/Kiosky

2. Navigate to the project directory:

❯ cd Kiosky

3. Install the project dependencies:

Launch it and start

---

Project Roadmap

• Responsive
• Add an error handler
• Create an admin panel

---

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the Kiosky project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/MaxenceLebrunDEV/Kiosky

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the GNU GENERAL PUBLIC LICENSE. For more details, refer to the LICENSE file.

---

---