ZarSDT OnlineMenu Builder

Overview

Welcome to the ZarSDT OnlineMenu Builder! This is a modern .Net/Angular application designed to streamline reservations with a responsive and intuitive user interface. The application leverages:

• .Net C# WebAPI: A robust framework for building dynamic WebAPIs.
• Angular: A robust framework for building dynamic web applications.
• Bootstrap 5.3: For a modern, responsive design.
• Ng-Bootstrap: To integrate Angular-specific Bootstrap components seamlessly.

---

Table of Contents

1. Prerequisites
2. Installation
3. Development
4. Scripts
5. Folder Structure
6. Contributing
7. License

---

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Node.js (LTS version recommended): Download here
• Yarn Classic: Install globally using:

  npm install -g yarn

• Angular CLI: Install globally using:

  yarn global add @angular/cli

---

Installation

To get started with the ORCUS Reservation System:

1. Clone the repository:

   git clone https://github.com/ab0utzahra/final-project.git

2. Navigate into the project directory:

   cd Reservation-CRS-V3

3. Install dependencies using Yarn:

   yarn install

---

Development

Run the development server with the following command:

yarn start

This executes:

ng serve --host 0.0.0.0 --port 4400

The application will be available at http://localhost:4400.

Notes:

• The server listens on all network interfaces (host 0.0.0.0).
• Default port is 4400. Update the package.json or angular.json to modify it if needed.

---

Scripts

Here are some commonly used Yarn scripts:

Command	Description
yarn start	Start the development server.
yarn build	Build the project for production.
yarn lint	Run linting checks.
yarn test	Run unit tests.
yarn e2e	Run end-to-end tests.

---

Folder Structure

Key directories and files:

orcus-reservation-system/
|-- src/
|   |-- app/               # Main application logic.
|   |-- assets/            # Static assets (images, fonts, etc.).
|   |-- environments/      # Environment-specific configurations.
|-- angular.json           # Angular CLI configuration.
|-- package.json           # Project metadata and dependencies.
|-- yarn.lock              # Dependency lock file for Yarn.

---

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a new feature branch:

   git checkout -b feature/your-feature-name

3. Commit your changes and push:

   git commit -m "Add your commit message here"
   git push origin feature/your-feature-name

4. Submit a pull request for review.

---

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute as per the terms of the license.

---

Support

If you encounter any issues or have questions, please feel free to reach out to the team via the repository's Issues section or contact us directly.

Happy coding! 🎉