Kanban Restaurant
📗 Table of Contents
📖 Kanban Restaurant
This project Kanban Restaurant is a project that demonstrates the use of HTML & CSS and Javascript Moduler development.
With External API consumption, it also demonstrates the proper use of Async and Await to send and receive data.
Built using WEBPACK following GitFlow it is very simple yet powerful project served by WEBPACK DEV SERVER . Along with dynamic modification of the DOM with Events including all the coding best practices.
🛠 Built With
Tech Stack
Key Features
- Use of callbacks and promises.
- Use of async and await.
- Use proper ES6 syntax and ES6 modules to write modular JavaScript.
🚀 Live Demo
Please follow the link for a live demo.
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- Git.
- An IDE (e.g. VS Code)
- Browser to run.
Setup
Clone this repository to your desired folder:
- Using Git Bash or any integrated terminal of you choice.
- Open with code editor (e.g. VS Code).
- Open the index.html file using any local server (e.g. live server extension in VS Code)
Usage
To run the project, execute the following command:
- Open the index.html file on a local server on your browser.
To add dependencies and run linter tests
Follow the following:
Initial Step:
- mkdir .github/workflows
- copy the linters.yml file to the directory created above.
- touch .gitignore if not created already and add node_modules/ to it.
- initialize npm to create package.json file by running the command:
$ npm i -y
(here i for install & -y for saying yes to all)
For Webpack:
- To install Webpack and Webpack CLI:
$ npm install webpack webpack-cli --save-dev
- To optaionally install a JS library as an example (e.g. Lodash)
$ npm install --save lodash (optional)
- To install the HtmlWebpackPlugin plugin.
$ npm install --save-dev html-webpack-plugin
- To install style-loader and css-loader
$ npm install --save-dev style-loader css-loader
- To install the webpack-dev-server as a dev dependency (to use live reloading)
$ npm install --save-dev webpack-dev-server
- List of the commands to run the build (with all the alternatives).
To build and run with the webpack dev server:
$ npm start
(Will be served at: http://localhost:8080/)
$ npm run build
(and then may be served using a local server e. g. Live Server in VS Code)
$ npm run webpack or, $ npm run webpack --mode production
$ npx webpack
$ npx webpack --mode production
$ npx webpack --config webpack.config.js
For Webhint (optional):
npm install --save-dev hint@7.x
- To fix validation errors run:
npx hint .
For Stylelint
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
npx stylelint "**/*.{css,scss}"
on the root of your directory of your project.
ESLint
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
npx eslint .
on the root of your directory of your project.
Deployment
You can deploy this project using:
- GitHub Pages for the main branch. A deployed version can be found here:
https://...
👥 Author
Developed by:
Authors
GitHub: ghermaico135
GitHub: maryam0007
🔭 Future Features
- Improve Aesthetics & Design
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
As a tech enthusiast, your support is always appreciated. If you like this project please do let me know with your support in any way you see fit.
🙏 Acknowledgments
I would like to thank Microverse for this project & project guidelines.
❓ FAQ
📝 License
This project is MIT licensed.