https://github.com/quantgeekdev/yum-burger-front
YumBurger Front End
https://github.com/quantgeekdev/yum-burger-front
Last synced: 4 months ago
JSON representation
YumBurger Front End
- Host: GitHub
- URL: https://github.com/quantgeekdev/yum-burger-front
- Owner: QuantGeekDev
- Created: 2024-01-06T15:24:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T13:40:18.000Z (about 2 years ago)
- Last Synced: 2025-03-24T04:35:53.451Z (11 months ago)
- Language: TypeScript
- Homepage: https://yum-burger.netlify.app/home
- Size: 30.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nyam Burger - Front-End
Nyam Burger is a front-end application that serves as a CRUD (Create, Read, Update, Delete) interface for managing hamburgers. The application features a Burger List with burger cards, a detailed page for each burger, and functionalities to edit, delete, and add new burgers.
## Quality and Coverage
- **Quality Gate Status**:
[](https://sonarcloud.io/summary/new_code?id=isdi-coders-2023_Alex-Andrushevich-Final-Project-front-202309-bcn)
- **Coverage**:
[](https://sonarcloud.io/summary/new_code?id=isdi-coders-2023_Alex-Andrushevich-Final-Project-front-202309-bcn)
- **Maintainability Rating**:
[](https://sonarcloud.io/summary/new_code?id=isdi-coders-2023_Alex-Andrushevich-Final-Project-front-202309-bcn)
## Getting Started
To get started with Nyam Burger, follow these steps:
1. Clone the repository:
```bash
git clone [repository-url]
```
2. Navigate to the project directory:
```bash
cd nyam-burger-front-end
```
3. Install dependencies:
```bash
npm install
```
4. Run the development server:
```bash
npm run dev
```
This will start the development server, and you can access the application. Make sure to provide VITE_API_URL environment variables for the backend.
## Available Scripts
- **dev**: Run the Vite development server.
- **build**: Build the project using TypeScript and Vite.
- **lint**: Run ESLint to check for code style and potential issues.
- **preview**: Run Vite in preview mode.
- **test**: Run tests using Vitest.
- **test:dev**: Run tests in watch mode.
- **test:coverage**: Run tests with coverage reporting.
## License
This project is licensed under the [MIT License](LICENSE).