https://github.com/cyrus-kiprop/restaurant_page
A simple restaurant homepage -> DOM manipulation using vanilla JavaScript
https://github.com/cyrus-kiprop/restaurant_page
Last synced: about 1 month ago
JSON representation
A simple restaurant homepage -> DOM manipulation using vanilla JavaScript
- Host: GitHub
- URL: https://github.com/cyrus-kiprop/restaurant_page
- Owner: Cyrus-Kiprop
- License: mit
- Created: 2020-06-23T15:46:32.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-05T03:58:22.000Z (about 2 years ago)
- Last Synced: 2025-02-13T02:31:10.718Z (3 months ago)
- Language: JavaScript
- Size: 4.28 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
A SIMPLE RESTAURANT APP
A web App created in the fulfillment of Microverse mandatory Javascript restaurant project.
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
- [About the Project](#about-the-project)
- [Live Demo](#live-demo)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## About The Project
The app is built using native javascript api for manipulating the DOM. The main aim of this app was to aquaint the learner with DOM manipulation skills using vanilla Javascript. The site constitutes of 3 tab sections, mainly:-
```sh
Home (Landing Page)
```
- This section contains a simple dummy description of the restaurant app.
- This is also the landing page.
```sh
About Section
```
- This section a dummy description of the restaurant app.
```sh
Menu Section.
```
- Constitutes dummy delicacies offered by the restaurant to it's customers.
```sh
```
## Live Demo
Click [ here ](https://raw.githack.com/Cyrus-Kiprop/restaurant_page/gh-pages/index.html) for a live demo of the app.
### Built With
The project was built using the following languages stacks:
```sh
Front-End(client)
```
- [Bootstrap v 4](https://getbootstrap.com)
- HTML
- JavaScript
- [Font Awesome Icons](https://fontawesome.com/icons?d=gallery)
```sh
Testing Frameworks
```
- N/A
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Node
- Basic knowledge of npm/yarn
### Installation
1. Clone the repo
```sh
git clone https://github.com/Cyrus-Kiprop/restaurant_page
```
2. CD into the project root directory
```sh
cd ./restaurant_page
```
3. Install Dependencies and packages
```sh
npm install
```
4. Build the files
```sh
npm run build
```
## Usage
Open the index.html file using live servers.
```sh
right click on index.html file and open it with the browser or with live server.
```
### Navigate to your browser and open port 8080 (use your live server port):
```JS
http//localhost:8080
```
### Navigate and Enjoy
## Roadmap
See the [open issues](https://github.com/Cyrus-Kiprop/restaurant_page/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/NewAwesomeFeature`)
3. Commit your Changes (`git commit -m 'Add some NewAmazingFeature'`)
4. Push to the Branch (`git push origin feature/NewAmazingFeature`)
5. Open a Pull Request
## Contact
Cyrus Kiprop - [email protected]
Project Link: [https://github.com/Cyrus-Kiprop/restaurant_page](https://github.com/Cyrus-Kiprop/restaurant_page)
## Authors
👤 **Cyrus Kiprop**
- Github: [Cyrus-Kiprop](https://github.com/Cyrus-Kiprop)
- Twitter: [@kipropJS](https://twitter.com/kipropJS)
- Linkedin: [Cyrus Kiprop](https://www.linkedin.com/in/cyrus-kiprop-ba7320120/)
## Acknowledgements
- [Font Awesome](https://fontawesome.com)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
- [PNG-SVG converter](https://image.online-convert.com/convert-to-svg)
## License
Distributed under the MIT License. See [ LICENSE ](https://github.com/Cyrus-Kiprop/restaurant_page/blob/master/LICENSE) for more information.
[contributors-shield]: https://img.shields.io/github/contributors/Cyrus-Kiprop/restaurant_page.svg?style=flat-square
[contributors-url]: https://github.com/Cyrus-Kiprop/restaurant_page/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Cyrus-Kiprop/restaurant_page.svg?style=flat-square
[forks-url]: https://github.com/Cyrus-Kiprop/restaurant_page/network/members
[stars-shield]: https://img.shields.io/github/stars/Cyrus-Kiprop/restaurant_page.svg?style=flat-square
[stars-url]: https://github.com/Cyrus-Kiprop/restaurant_page/stargazers
[issues-shield]: https://img.shields.io/github/issues/Cyrus-Kiprop/restaurant_page.svg?style=flat-square
[issues-url]: https://github.com/Cyrus-Kiprop/restaurant_page/issues
[product-screenshot]: /app/assets/images/screenshot.png