Directions for use:
First, you need to check your database settings in database_config.py
and define your database login credentials in constants.py
. We have created an example of constants.py
with the example-constants.py
file.
python3 -m pip install -r requirements.txt --user
then go into the myClient
directory
edit .env with the appropriate baseURL address for the api server
and run
yarn build
Then you can go back out of the myClient
directory and run the server
python3 main.py
yarn
is a package management tool for javascript libraries. To learn more about Yarn, you can view their webpage. In order to get started using Yarn, you can look here.
This project is organized into 3 stacks -- the front-end,
the back-end, and the database. Using
Flask blueprints,
we register different paths which specify access
to different resources on the server.
All the paths can be found in the routes
directory.
The front end is a
single-page application (SPA)
using React.
Javascript is built and compiled into the myClient/build
directory,
which is where all statically served files are sent from.
2403d4ed2908a12d2ea9cb927160b266a848d8a4