Tired from working a lot on your terminal? Feeling hungry?
Now you can order a Pizza on the fly, directly through your command line using flick!
flick is the combination of a CLI application that interacts with a webserver with information about various pizza joints and their menu. Your Pizza is just a command away.
(Note: This is just a mock-up for now, and doesn't actually order a pizza)
flask: Powers the webserver that serves the joints' info, their data and receives orders$ click_: Heart of the Command-Line client that the user interacts with
- Clone this repository by running
git clone https://github.com/akshgpt7/flickand cd into it. - Make sure you have pipenv installed on your system. If not, do it by
pip install pipenv. - To activate a virtual environment for the project, run
pipenv shell. After this, you'll be inside the virtual environment. - Install the dependencies by running
pipenv install.
- cd into the webserver directory using
cd src/webserver. - Run the command
flask run. - The server will now be up and running.
Note: This can be done system wide (outside the pipenv) if you just want to use the client, but it's highly recommended to do it inside the virtual env for development.
- In a new terminal window, cd into the cli directory by
cd src/cli. - Run the following command:
- Linux:
python3 -m pip install --editable . - Windows:
pip install -e .
- Linux:
- Use any
flickcommand now!
Type flick --help to see a help message, and a list of commands you can use.
Type flick [command-name] --help to see help for a particular command.
joint-infoView information about a specific pizza jointorderPlace your order for pizza :)rateSend a review for a pizza joint!show-jointsView all available pizza jointsshow-menuShow menu items for joint specified