- Table of Contents
- Installation
- Usage
- Contributing
- Tests
- License
- Contact
- Creator and Acknowledgements
- Credits
- Badges
This app uses features of Node, SQL and Handlebars to dynamically generate a list of burger items, and to present them as per the action of if they have been eaten or not!
Screenshot of Project (Google Chrome):
Video of app in action. Chrome: local host version: (./BurgerAppVid.mp4); Heroku link: https://infinite-sea-20127.herokuapp.com/ deployed to Heroku
To get a local copy up and running follow these simple steps.
Downloaded source instructions from GitLab Repo, created and tested code in VS code (including integrated terminal). Viewed layout in Google Chrome. Uploaded to Github. Created databases for local instance and Heroku instance in MySQL. Deployed to GitHub and Heroku.
Prerequisites This is an example of how to list things you need to use the software and how to install them.
Installation- Clone the repo git clone https://github.com/vetty88/Burger App.git Install NPM packages npm install npm inquirer npm audit fix Then open index.js file in console log and run node index.js You will be taken through a series of questions (user prompts) which will then lead to the generation of your new readme.md file!
This project can be used for undefined. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Regarding this project I respectfully make the following requests regarding contributions:
You are welcome to contribute to this project
Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request
See the open issues for a list of proposed features (and known issues). Testing completed and any known issues include the following: Tested in VS Code and integrated terminal. Tested on google chrome for layout and functionality. Launched to Heroku, connection works. Databse created and tested in MySQL for local feature and Heroku version.
Your Name - vetty88@gmail.com
Project Link: https://github.com/vetty88/Burger-App
Code Author (original assignment): Monash University/Trilogy Education.
Resources utilised to research to edit the code:
- Monash University ReadMe and Slide Materials
- Mozilla MDN WebDocs: https://developer.mozilla.org/en-US/
- W3 Schools: https://www.w3schools.com/
- Stack Overflow: https://www.stackoverflow.com/