cyrus-kiprop / restaurant_page

A simple restaurant homepage -> DOM manipulation using vanilla JavaScript

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
  • Live Demo
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• 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:-

Home (Landing Page)

• This section contains a simple dummy description of the restaurant app.
• This is also the landing page.

About Section

• This section a dummy description of the restaurant app.

Menu Section.

• Constitutes dummy delicacies offered by the restaurant to it's customers.

Live Demo

Click here for a live demo of the app.

Built With

The project was built using the following languages stacks:

Front-End(client)

• Bootstrap v 4
• HTML
• JavaScript
• Font Awesome Icons

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

git clone https://github.com/Cyrus-Kiprop/restaurant_page

2. CD into the project root directory

cd ./restaurant_page

3. Install Dependencies and packages

npm install

4. Build the files

npm run build

Usage

Open the index.html file using live servers.

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):

http//localhost:8080

Navigate and Enjoy

Roadmap

See the open 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

Authors

👤 Cyrus Kiprop

• Github: Cyrus-Kiprop
• Twitter: @kipropJS
• Linkedin: Cyrus Kiprop

Acknowledgements

• Font Awesome
• Best-README-Template
• PNG-SVG converter

License

Distributed under the MIT License. See LICENSE for more information.