Skip to content

Commit

Permalink
docs: readme (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
karol-wolski authored Jun 28, 2023
1 parent ec22d6a commit a2eb00e
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,24 @@
- [Technologies and libraries](#technologies-and-libraries)
- [Setup](#setup)
- [Build](#build)
- [Features](#features)
- [Screenshots](#screenshots)
- [Mobile](#mobile)
- [Desktop](#desktop)

## General info

Project status: _in progress_
This is a simple HTML, CSS and JavaScript project in which I am developing the basics of Front-End Development. In this project I also use external libraries such as AOS, Venobox and FocusTrap. The graphic design was made entirely in Figma and can be seen by [clicking here](https://www.figma.com/file/xRbR691Iqp9aGor2WNA69Q/Restaurant?type=design&node-id=0%3A1&mode=design&t=LzqfbjG98nlPlFDz-1).
Project status: _done_

## Technologies and libraries

- HTML
- CSS
- JavaScript
- [AOS](http://michalsnik.github.io/aos/)
- [Venobox](https://veno.es/venobox/)
- [FocusTrap](https://github.com/focus-trap/focus-trap)

## Setup

To run this project, install it locally using npm:
Expand All @@ -36,10 +43,30 @@ To build this project:
npm run build
```

## Features

## Screenshots

### Mobile

<div>
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/6a88073d-6c08-433f-9120-6ad0da949c0c" alt="Mobile_main_view" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/0d87dd99-8dd8-40b6-9d4a-541032004bc1" alt="Mobile_nav" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/28aecf1f-a6aa-4108-a348-2ef3ec41f1d1" alt="Mobile_about" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/a211cc1d-bf52-4697-8671-b3ae01735fb1" alt="Mobile_food_menu" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/c7a60675-adbb-4c17-a0bc-a1a7d41b5264" alt="mobile_food_gallery" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/5b0eae6a-c911-4829-82d8-f0d181e2bf17" alt="mobile_gallery_full" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/6e87dbd0-f386-4068-b9c7-69e9ec245234" alt="mobile_contact" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/944c2faf-8259-4ea8-a33c-6e5b4f3a3b21" alt="mobile_contact_form" />
<img width="220" src="https://github.com/karol-wolski/Restaurant_2023/assets/15778908/47c95b00-3852-4528-bf40-f3a759c42520" alt="mobile_book_table" />
</div>

### Desktop

![Main_view](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/e155691d-26b4-4244-af60-c0d21cbb2de7)
![About](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/66ad43b2-a79e-4661-a24d-169852075723)
![Menu](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/69877e29-cc5d-4ef1-bc07-ce2a5fa9e805)
![Food_Gallery](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/d46746c2-2f91-4479-9196-4cc868f02e2a)
![Foor_gallery_full](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/81ebb23c-a128-4273-8390-1414d1f27347)
![Contact](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/60cfe012-f819-48f8-9672-b263bc6e4400)
![Contact_errors](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/2627fcc4-c0d8-4752-b596-97c4a10505ca)
![Book_table](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/fd1d7cc7-341c-4b27-be85-20353c3932ca)
![Book_table_errors](https://github.com/karol-wolski/Restaurant_2023/assets/15778908/976b56b5-fb2d-4887-9599-efc66199a002)

0 comments on commit a2eb00e

Please sign in to comment.