Restauranter is an open-source restaurant management web app. A user can act as a Patron and/or Proprietor. A corresponding Rails API can be found at https://github.com/ronsala/restauranter-backend.
Patrons can ...
- Choose a restaurant
- order dishes from a menu
- arrange to pick up or dine in
- check out
Proprietors can ...
- Sign up for an account
- Set up a restaurant and menu
- Edit a restaurant and menu
- See their restaurant's orders and mark them fulfilled
You can watch a video demo here.
You can read a blog post about the creation of the app here.
Ruby 2.6.3
Rails 6.0.3.6
You can either clone the repository directly from GitHub into a local directory on your computer or you can Fork the app so that you can contribute to the code.
Once you Fork or Clone this app, cd into that directory and then execute:
npm startRestauranter uses Cypress for testing and Behavior Driven Development.
To run headless:
npm test for all tests
npm test -- --spec "[path/to/test/file]" for a specific test, e.g.,
npm test -- --spec "cypress/integration/home.spec.js"
To run tests in a browser:
npm run cy:open
then, in the Cypress window that opens, click Run [number] integration specs for all tests or an individual test for that one alone.
Bug reports and pull requests are welcome on GitHub at https://github.com/ronsala/restauranter-frontend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
This app is available as open source under the terms of the MIT License.
- Flatiron School for instruction and community.
- My spouse for support and cheerleading.
- Image creators:
- Skarg for "Photograph of Restaurant Row parking lot in San Marcos, California", protected under a Creative Commons Attribution-Share Alike 4.0 International license. The image is unmodified from the original.
- David Stanley for "Roadside Restaurateur", protected under a Creative Commons Attribution 2.0 Generic license. The image is unmodified from the original.