Commit fd212330 authored by D.H.D. Nguyen's avatar D.H.D. Nguyen
Browse files

update

parent 07ebd256

config.py

+13 −6
Original line number Diff line number Diff line
@@ -18,10 +18,14 @@ class Config: 
	Args:

		SECRET_KEY (str): secret key of the web application

		BASE_DIR (str): base directory of the application

		SQLALCHEMY_TRACK_MODIFICATIONS (bool): whether to track modification when using SQLAlchemy, *default:* ``False``

		SQLALCHEMY_DATABASE_URI (str): directory of the local SQL database, *default:* ``SQLite database``

		SQLALCHEMY_TRACK_MODIFICATIONS (bool): whether to track modification when using SQLAlchemy, 

											*default:* ``False``

		SQLALCHEMY_DATABASE_URI (str): directory of the local SQL database, 

											*default:* ``SQLite database``

		MTURK_URL (str): endpoint of Amazon Crowdsourcing Platform, *default:* ``None``

		MTURK_SHOW_UP_URL (str): link to where the project is uploaded (mainly in production environment), *default:* `real page <https://requester.mturk.com/>`__

		MTURK_SHOW_UP_URL (str): link to where the project is uploaded 

								(mainly in production environment), 

								*default:* `real page <https://requester.mturk.com/>`__

		

	Methods:

		init_app(app) : Application initialization
@@ -45,10 +49,12 @@ class DevelopmentConfig(Config): 
		FLASK_ENV (str): environment of the application, *default:* ``development``

		DEBUG (bool): whether to debug during running the application, *default:* ``True``

		SQLALCHEMY_DATABASE_URI (str): SQL database used for development

		MTURK_URL (str): endpoint of Amazon Crowdsourcing Platform, used in Development environment, *default:* `sandbox in us-east-1 region <https://mturk-requester-sandbox.us-east-1.amazonaws.com>`__

		MTURK_URL (str): endpoint of Amazon Crowdsourcing Platform, used in Development environment, 

				*default:* `sandbox in us-east-1 region <https://mturk-requester-sandbox.us-east-1.amazonaws.com>`__

		AWS_ACCESS_KEY_ID (str): IAM AWS credentials - key id, *default:* ``None``

		AWS_SECRET_ACCESS_KEY (str): IAM AWS credentials - secret access key, *default:* ``None``

		MTURK_SHOW_UP_URL: link to where the project is uploaded, in development environment, *default:* `Sandbox <https://workersandbox.mturk.com/>`__

		MTURK_SHOW_UP_URL: link to where the project is uploaded, in development environment, 

				*default:* `Sandbox <https://workersandbox.mturk.com/>`__

	"""

	FLASK_ENV = 'development'

	DEBUG = True
@@ -67,7 +73,8 @@ class TestingConfig(Config): 
		DEBUG (bool): whether to debug during running the application, *default:* ``False``

		TESTING (bool): whether to set this application in testing environment, *default:* ``True``

		SQLALCHEMY_DATABASE_URI (str): SQL database used for testing

		WTF_CSRF_ENABLED (bool): whether to enable CSRF Token for different input forms in HTML, *default:* ``False``

		WTF_CSRF_ENABLED (bool): whether to enable CSRF Token for different input forms in HTML, 

							*default:* ``False``

	"""

	DEBUG = False

	TESTING = True

doc/source/index.rst

+4 −1
Original line number Diff line number Diff line
@@ -15,10 +15,13 @@ Backend is mainly developed on `Python3.6 <https://www.python.org/downloads/rele 


During developing frontend, besides `HTML <https://www.w3schools.com/html/default.asp>`__, `CSS <https://www.w3schools.com/css/default.asp>`__, `JavaScript <https://www.w3schools.com/js/default.asp>`__ and `Bootstrap4 <https://getbootstrap.com/>`__, most of the templates use `Jinja2 <https://jinja.palletsprojects.com/en/2.11.x/>`__ for dynamic rendering.



Links

-------

`Source code <https://gitlab.cl.uni-heidelberg.de/nguyen/swp>`__





Contents

---------------------

`Source code <https://gitlab.cl.uni-heidelberg.de/nguyen/swp>`__



Backend

########