File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -247,31 +247,12 @@ To run the Flask or Django container:
247247
248248### Running Locally
249249
250- 1 . Both example applications utilise the env variables described in [ Configuration] ( #configuration ) , make sure they are accessible.
251- 1 . Ensure pip is up to date: ` easy_install --upgrade pip `
252- 1 . Ensure setuptools and wheel are up to date: ` python -m pip install --upgrade setuptools wheel `
250+ #### Follow instructions in the README for each example:
253251
254- #### Flask
255-
256- 1 . Change directories to the Flask project: ` cd examples/yoti_example_flask `
257- 1 . Install dependencies: ` pip install -r requirements.txt `
258- 1 . Run ` python app.py `
259- 1 . Navigate to https://localhost:5000
260-
261- #### Django
262-
263- 1 . You will need Python 3+ to run the Django example
264- 1 . Change directories to the Django project: ` cd examples/yoti_example_django `
265- 1 . Install dependencies: ` pip install -r requirements.txt `
266- 1 . Apply migrations before the first start by running: ` python manage.py migrate `
267- 1 . Run: ` python manage.py runsslserver 0.0.0.0:5000 `
268- 1 . Navigate to https://localhost:5000
269-
270- #### AML Example
271-
272- 1 . Change directories to the AML folder: ` cd examples/aml `
273- 1 . Install requirements with ` pip install -r requirements.txt `
274- 1 . Run: ` python app.py `
252+ * [ Profile - Django] ( examples/yoti_example_django )
253+ * [ Profile - Flask] ( examples/yoti_example_flask )
254+ * [ AML] ( examples/aml )
255+ * [ Doc Scan] ( examples/doc_scan )
275256
276257## Running the Tests
277258
Original file line number Diff line number Diff line change 1+ ### AML Example Project
2+
3+ 1 . Rename the [ .env.example] ( .env.example ) file to ` .env ` and fill in the required configuration values
4+ 1 . Install requirements with ` pip install -r requirements.txt `
5+ 1 . Run: ` python app.py `
Original file line number Diff line number Diff line change 1+ ### Django Profile Example Project
2+
3+ 1 . Rename the [ .env.example] ( .env.example ) file to ` .env ` and fill in the required configuration values
4+ 1 . Install dependencies: ` pip install -r requirements.txt `
5+ 1 . Apply migrations before the first start by running: ` python manage.py migrate `
6+ 1 . Run: ` python manage.py runsslserver 0.0.0.0:5000 `
7+ 1 . Navigate to https://localhost:5000
Original file line number Diff line number Diff line change 1+ #### Flask Profile Example Project
2+
3+ 1 . Rename the [ .env.example] ( .env.example ) file to ` .env ` and fill in the required configuration values
4+ 1 . Install dependencies: ` pip install -r requirements.txt `
5+ 1 . Run ` python app.py `
6+ 1 . Navigate to https://localhost:5000
You can’t perform that action at this time.
0 commit comments