Espresso is a learning exercise by Ryan Bacon and myself to build a small web app from scratch. The app will be like a simple version of Yelp that collects and displays user reviews of places that serve espresso.
Initially, this project will consist of a backend implemented in Flask, SQLAlchemy, and PostgreSQL to support an API.
The frontend will be a web client using asynchronous calls to the API, or it may be a native smartphone app such as for Android phones.
To run the app using flask on the command line,
$ export FLASK_APP=espresso.py
$ flask run
Or you can run via
$ python3 espresso.py
Executing within an IDE such as PyCharm is great since it has a graphical debugger.
The Python modules used are listed in requirements.txt
One way to install all of these modules is to do:
$ pip3 install -r requirements.txt
We are using PostgreSQL for the backend database. On Ubuntu systems, PostgreSQL can be installed by the following command. Our current version is 10.14
$ sudo apt-get install postgres
Then you might want to modify the PATH like so:
$ export PATH=/usr/lib/postgresql/10/bin:$PATH
For people who like to use command line utilities, Postgres comes
with psql. It is very handy for accessing and manipulating
the Postgres databases with its commands as well as
SQL statements.
For connecting to the Postgres database, four environment variables need to be set:
ESPRESSO_DB_USER
ESPRESSO_DB_PASSWORD
ESPRESSO_DB_HOST
ESPRESSO_DB_DATABASE_NAME
Automated tests have been created using the unittest module. Four environment variables for testing need to be set. During testing the values of these variables are used instead of the normal values as set above.
ESPRESSO_TEST_DB_USER
ESPRESSO_TEST_DB_PASSWORD
ESPRESSO_TEST_DB_HOST
ESPRESSO_TEST_DB_DATABASE_NAME
The above env variables can be set either within a .env file that sits at the
top level of the project directory, or they can be set within the terminal
environment where the app is run, or some combination of the two.
The syntax is the same for both, e.g.
ESPRESSO_DB_USER=earl
With the added use of Auth0 for required authorization to access the API backend, testing needs two additional environment variables to be set. Their values are available in the Auth0 dashboard under the Espresso Reviews API (Test Application) application.
AUTH0_CLIENT_ID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
AUTH0_CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Here some examples of how to run the tests.
$ python3 -m unittest tests/test_restaurants.py
Or use nose2 to discover and run all the tests.
$ nose2 -v