https://github.com/jesusgraterol/restaurant-top
This is a website skeleton that can be used by any restaurant to showcase their dishes and it is the submission for The Odin Project: Restaurant Page.
https://github.com/jesusgraterol/restaurant-top
theodinproject theodinproject-nodejs theodinprojectfoundations
Last synced: 9 days ago
JSON representation
This is a website skeleton that can be used by any restaurant to showcase their dishes and it is the submission for The Odin Project: Restaurant Page.
- Host: GitHub
- URL: https://github.com/jesusgraterol/restaurant-top
- Owner: jesusgraterol
- Created: 2023-10-12T14:52:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-30T15:37:55.000Z (over 2 years ago)
- Last Synced: 2025-01-17T09:32:26.274Z (over 1 year ago)
- Topics: theodinproject, theodinproject-nodejs, theodinprojectfoundations
- Language: JavaScript
- Homepage: https://jesusgraterol.github.io/restaurant-top/
- Size: 2.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restaurant Page
This is a website skeleton that can be used by any restaurant to showcase their dishes and it is the submission for [The Odin Project: Restaurant Page](https://www.theodinproject.com/lessons/node-path-javascript-restaurant-page).
The key features are:
- Beautiful and modern layout that can be used by any restaurant
- Well structured and easy to use display of the restaurant's menu and contact information
- Optimized Build
- Cross-Platform Compatibility
## Live Demo
[Restaurant Page](https://jesusgraterol.github.io/restaurant-top/)
## Getting Started
### Requirements
- GIT
- NodeJS ^v21.0.0
- NPM ^v10.2.0
### Installation
1) Clone the repository
```bash
git clone git@github.com:jesusgraterol/restaurant-top.git
```
2) Install the dependencies
```bash
npm install
```
## Usage
1) Run the Webpack Build in `watch` mode
```bash
npm start
```
2) Open the `./dist/index.html` file with your favorite browser.
## Build Process
1) Run the Webpack Build
```bash
npm run build
```
## Deployment
1) Push the new build to the `gh-pages` branch so it is deployed to **Github Pages**:
```bash
git subtree push --prefix dist origin gh-pages
```
## Built With
- HTML5
- CSS3
- JavaScript
- Webpack
## Running the Tests
```bash
# Unit Tests
N/A
# Integration Tests
N/A
# E2E Tests
N/A
```
## @TODO
N/A
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Acknowledgments
- [Google Fonts](https://fonts.google.com/icons)