Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.68 KB

README.md

File metadata and controls

35 lines (18 loc) · 1.68 KB

virtual-menu

This is a simple web app that shows has a virtual menu for restaurants which is easier to read and is better then the pdf most restaurants use

Installation

First, fork and clone the repository and where on your local machine. After it has been correctly cloned, navigate into the virtual-menu/virtual-menu-backend directory and in your terminal execute:

$ bundle install 

This will download all the correct gems needed. After everything is correctly installed in the terminal enter:

$ rail s 

Second, once the rails backend server has successfully started and is up and running, you will need to start the front end react server by navigating to virtual-menu/virtual-menu-frontend and execute:

$ npm install 

This will download all the dependencies needed to run correctly. After everything is correctly installed, in your terminal execute:

$ npm start 

This will start running the frontend server and will automatically open http://localhost:3001/ in your default browser.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RTBlanco/virtual-menu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the HeroIndex project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.